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:

Configure the HealthCheck.DetailsKey parameter in appSettings. The value you set for this parameter serves as a password which allows you to access the health checks.
Example: "HealthCheck.DetailsKey":"12345"
Restart IIS to ensure that the change takes effect.
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.