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.

GETyouragentURL.symphony.com/agent/v3/health/extended

Response

200503

Agent is healthy, all components are UP.

Body

application/json

servicesobject

statusV3HealthStatus (enum)

Application health status.

UPDOWN

usersobject

versionstring

Required Agent verison

Request

JavaScriptCurl

const response = await fetch('youragentURL.symphony.com/agent/v3/health/extended', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "UP",
  "version": "text"
}

📘 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