Health Check
All APIs provide an endpoint for checking the health of the service. The common health check endpoint can be accessed via:
Security service health check endpoint:
1 | |
1 | |
1 | |
The response from this endpoint is a plaintext string representing the status. The format of the status adheres to and honors standard HTTP status codes formatting. Below are the response codes that you may see when calling the health check endpoint:
- 200 OK - Healthy. Services are operating as expected.
- 503 Service Unavailable - Unhealthy. Will be returned if a service is down for maintenance or other reasons.
It is necessary to view the server logs to identify the true case of a health issue.