Health Check Endpoints

Make sure all your services are up and running by making API calls to special endpoints, called health check endpoints.

These endpoints run health checks and return a status that tells you if the service you are checking is functional or not.

Orchestrator Health Check Endpoint

To check the availability of your Orchestrator instance and its dependencies, use the following endpoint:

• GET {BaseURL}/api/status

Identity Server Health Check Endpoint

To check if the Identity Server is working, use the following endpoint:

• GET {BaseURL}/identity/.well-known/openid-configuration

The response body of this endpoint summarizes the Identity Server configuration.

Webhooks Health Check Endpoint

To check the availability of your Webhooks service, use the following endpoint:

• GET /api/status

Response Code Interpretation

Interpret the response code as follows:

• 200 OK—your service is up and running
• 5xx failure—your service is down

Some health checks may return a 200 OK response code and a Degraded status , meaning the checked component is in a degraded state.