Orchestrator Health Check Details Key Password In Automation Suite

News Knowledge Base
1

How to obtain the Orchestrator health check details key password in Automation Suite?

Issue Description: To perform an API health check for Orchestrator, the parameter 'detailsKey=password' must be included in the query payload.

Root Cause: This password is generated automatically in a secrets object called, "orchestrator-generated-secrets" within the UiPath namespace and must be obtained post installation.

Resolution:

  1. Run the following command to return the password's value:
  • kubectl get secrets/orchestrator-generated-secrets -n uipath -o "jsonpath={.data['APPSETTINGS\\__HealthCheck\.DetailsKey']}" | echo $(base64 -d)
    • note the password's value returned
  1. Navigate to the following endpoint
  • https://{fqdn}/api/health?detailsKey=password-value
    • If successful, the call returns a response body containing details about the health checks and their statuses.