This API specification is available for download as an Open API 3.0 YAML file:
For the server health check there is currently no authorization required.
Restrict Interface Access
It is strongly recommended to allow the access to the service only for server monitoring applications.
To retrieve the clusterstatus, please configure your clients to use this authentication method to submit user name and password.
To retrieve the clusterstatus for a UI-client, use basic authorization and just type in login and password.
Permission required
/health/clusterstatus
Returns the status of all app-servers of a cluster.
200 - OK The request succeeded.
401 - Unauthorized
403 - Forbidden
500 - Internal Server Error .
/health/status
Checks if the app-server is alive.
200 - OK The request succeeded.
500 - Internal Server Error
503 - Service Unavailable , possibly starting.
HealthCheckStatus
: Represents the current health status of an app-server.HealthCheckServiceStatus
objects. A list of all services and their status that were checked. | Example: ...
HealthCheckServiceStatus
: Represents the current health status of one service of an app-server.database
true
int32
| Example: 200
OK
...
backend
int32
| Example: 200
OK
int64
int64
date-time
date-time
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.