Health Check Extended

Returns the connectivity status of the Agent services as well as users connectivity.

Available on Agent 2.57.0 and above.

Checks health status of services and users

Available on Agent 2.57.0 and above.

Returns the connectivity status of the Agent services (pod, key manager and datafeed) as well as users connectivity (agentservice and ceservice).

The global status will be set to DOWN if at least one of the sub-status is also DOWN.

get

/v3/health/extended

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'youragentURL.symphony.com/agent/v3/health/extended'

200

503

200

{
  "status": "UP",
  "version": "text",
  "services": {
    "ANY_ADDITIONAL_PROPERTY": {
      "authType": "RSA",
      "message": "text",
      "status": "UP",
      "version": "text"
    }
  },
  "users": {
    "ANY_ADDITIONAL_PROPERTY": {
      "authType": "RSA",
      "message": "text",
      "status": "UP",
      "version": "text"
    }
  }
}

Agent is healthy, all components are UP.

📘 Result Fields

This API returns the connectivity status of the Agent services as well as users connectivity. The global status will be set to DOWN if at least one of the sub-status is also DOWN. Agent services: pod, key manager and datafeed. User connectivity: agentservice and ceservice