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 endpoints:

• GET

  https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/api/health—checks only critical dependencies

• GET

  https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/api/health/startup—checks every dependency

By default, the above health check endpoints return an empty response body.

To see which health checks have been performed and the statuses they hold:

1. In the orchestrator-customconfig config map (configured via orchestrator-configurator.sh), and
   add <add key="HealthCheck.DetailsKey" value="12345" /> in the <appsettings> section. 12345 serves as a password which allows you to access the health checks, so do not forget to change it with a value of your own.
2. Restart IIS to ensure that the change takes effect.
3. Use the previously set password as a query parameter in the health check API call (for example, /api/health?detailsKey=password). If successful, the call returns a response body containing details about the health checks and their statuses.

Once you complete these steps, the health check will also be accessible from a machine different to the Orchestrator server.

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 https://{yourDomain}/webhooks_/api/status

Resource Catalog Service health check endpoint

To check the availability of your Resource Catalog Service instance, use the following endpoint:

• GET/https://{yourDomain}/ResourceCatalog/health

The response body includes Healthy when the service is up and running.

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.