Orchestrator
2022.10
false
- Getting Started
- The Swagger Definition
- Examples using the Orchestrator API
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Queue Items Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management APIs
Orchestrator API Guide
Last updated 2023年11月10日
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.
To check the availability of your Orchestrator instance and its dependencies, use the following endpoints:
-
GET
/api/health
—checks only critical dependencies -
GET
/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:
- Open the
UiPath.Orchestrator.dll.config
file (C:\Program Files (x86)\UiPath\Orchestrator
). - Configure a password for the
HealthCheck.DetailsKey
setting. - Use the above 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.
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.
To check the availability of your Webhooks service, use the following endpoint:
-
GET
/api/status