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

get

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.

Responses

200

Agent is healthy, all components are UP.

application/json

statusstring · enumOptional

Application health status.

Possible values:

versionstringOptional

Required Agent verison

503

Agent is unhealthy, some components are DOWN.

application/json

get

/v3/health/extended

HTTPcURLJavaScriptPython

GET /agent/v3/health/extended HTTP/1.1
Host: youragentURL.symphony.com
Accept: */*

{
  "services": {
    "pod": {
      "status": "UP",
      "version": "24.1.1-411-36efd5b"
    },
    "key_manager": {
      "status": "UP",
      "version": "24.1.1-411-36efd5b"
    },
    "datafeed": {
      "status": "UP",
      "version": "2.11.6"
    }
  },
  "status": "UP",
  "users": {
    "agentservice": {
      "authType": "RSA",
      "status": "UP"
    },
    "ceservice": {
      "authType": "RSA",
      "status": "UP"
    }
  },
  "version": "24.3.2-778"
}

📘 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