Health endpoints

To effectively monitor the health of your Automation Suite services, you can use the health endpoints listed in this section. These endpoints allow you to quickly verify if a service is operating correctly.

Platform

• https://<automation-suite-fqdn>/pap_/health
• https://<automation-suite-fqdn>/pdp_/health
• https://<automation-suite-fqdn>/identity_/.well-known/openid-configuration
• https://<automation-suite-fqdn>/identity_/web/
• https://<automation-suite-fqdn>/lease_/health/
• https://<automation-suite-fqdn>/license_/health
• https://<automation-suite-fqdn>/organization_/health
• https://<automation-suite-fqdn>/portal_/portal/shallow/healthStatus
• https://<automation-suite-fqdn>/audit_/health
• https://<automation-suite-fqdn>/resourcecatalog_/health

Action Center

• https://<automation-suite-fqdn>/actions_/
• https://<automation-suite-fqdn>/bupproxyservice_/health/ready
• https://<automation-suite-fqdn>/processes_/

AI Center

• https://<automation-suite-fqdn>/aifabric_/ai-app
• https://<automation-suite-fqdn>/aifabric_/ai-deployer/actuator/health/ready
• https://<automation-suite-fqdn>/aifabric_/ai-trainer/actuator/health/ready
• https://<automation-suite-fqdn>/aifabric_/ai-pkgmanager/actuator/health/ready
• https://<automation-suite-fqdn>/aifabric_/ai-helper/actuator/health/ready
• https://<automation-suite-fqdn>/aistorage_/health

Apps

• https://<automation-suite-fqdn>/<org-name>/apps_/default/api/v1/default/system-health

Automation Hub

• https://<automation-suite-fqdn>/automationhub_/fd-api/v1/ping
• https://<automation-suite-fqdn>/automationstore_/fd-api/v1/ping

Data Service

• https://<automation-suite-fqdn>/dataservice_/api/HealthCheck/health
• https://<automation-suite-fqdn>/dataservice_/assets

Document Understanding

• https://<automation-suite-fqdn>/du_/api/documentmanager/health
• https://<automation-suite-fqdn>/du_/api/storage/health
• https://<automation-suite-fqdn>/du_/api/eventservice/health
• https://<automation-suite-fqdn>/du_/metering/alive
• https://<automation-suite-fqdn>/du_/ocr/info/ready
• https://<automation-suite-fqdn>/du_/extended-ocr/ready
• https://<automation-suite-fqdn>/du_/classify/MLclassification/info/ready
• https://<automation-suite-fqdn>/du_/svc/formextractor/info
• https://<automation-suite-fqdn>/du_/svc/intelligentkeywords/info

Insights

• https://<automation-suite-fqdn>/insights_/health

Notification Service

• https://<automation-suite-fqdn>/notificationservice_/notificationserviceapi/health/readiness
• https://<automation-suite-fqdn>/notificationservice_/usersubscriptionservice/health/readiness
• https://<automation-suite-fqdn>/notificationservice_/publishermetaservice/health/readiness

Orchestrator

• https://<automation-suite-fqdn>/orchestrator_/api/health

Robotube

• https://<automation-suite-fqdn>/robotube_/healthz

Task Mining

• https://<automation-suite-fqdn>/taskmining_/console/api/health
• https://<automation-suite-fqdn>/taskmining_/storage/api/health

Test Manager

• https://<automation-suite-fqdn>/testmanager_/api/health/live

Checking service health

To check the health of a specific service, send a request to its corresponding endpoint, as shown in the following example.

curl -kiso /dev/null -w "%{http_code}" https://<automation-suite-fqdn>/orchestrator_/api/health

A successful response with an HTTP status code 200 indicates that the service is healthy.