Perform a health check on server nodes with the REST API
This section provides information for getting health check results using the REST API.
Overview
This REST API call checks the health of each individual server node.
It can be particularly useful for load balancing. Run a health check on each node and if a node is not available, remove it from the load balancer.
Any user can perform the health check.
GET health check results
Send this REST API request.
GET http[s]://<server>:<port>/admin/server/status
Check the results
Check the results of the health check.
Code | Description |
---|---|
200 | The server is healthy. |
500 | Internal server error. The server is not healthy. |
See also: