Healthy HTTP endpoint
The Healthy HTTP endpoint provides a way to check whether the server is able to handle requests.
At any point in time, the server can become temporarily or permanently unable to handle requests. This endpoint returns 200 without content when the server is able to handle requests or 503 with a JSON containing the reasons why the server is not able to handle requests. The JSON response contains one or both of the following fields: "alive-errors": an array of serious errors. "healthy-errors": an array of transient errors. When only field "healthy-errors" is returned, the server should eventually recover by itself without administrative actions. When "alive-errors" is returned, an administrative action is needed.
Parent
The Healthy HTTP endpoint object inherits from HTTP Endpoint.
Healthy HTTP endpoint Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
| Basic Properties | Advanced Properties |
|---|---|
authorization-mechanism
Synopsis |
The HTTP authorization mechanisms supported by this HTTP Endpoint. |
Default Value |
None |
Allowed Values |
The name of an existing http-authorization-mechanism. The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled. |
Multi-valued |
Yes |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
Advanced Properties
Use the --advanced
option to access advanced properties.
java-class
Synopsis |
Specifies the fully-qualified name of the Java class that provides the Healthy HTTP endpoint implementation. |
Default Value |
org.opends.server.protocols.http.HealthyEndpoint |
Allowed Values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
Yes |
Read-Only |
No |