Alive HTTP endpoint
The Alive HTTP endpoint provides a way to check whether the server is facing serious problems that need administrative actions to recover.
This endpoint responds 200 without content when the server is alive or 503 with a JSON containing an array of serious errors in the field "alive-errors".
Parent
The Alive HTTP endpoint object inherits from HTTP Endpoint.
Alive 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 Alive HTTP endpoint implementation. |
Default value |
org.opends.server.protocols.http.AliveEndpoint |
Allowed values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin action required |
None |
Advanced |
Yes |
Read-only |
No |