Health Check

Returns the connectivity status of your Agent service.

If your Agent service is started and running properly, the status value will be UP.

Available on Agent 2.57.0 and above.

Checks health status

Available on Agent 2.57.0 and above.

Returns the connectivity status of your Agent server. If your Agent server is started and running, the status value will be UP

GETyouragentURL.symphony.com/agent/v3/health

Response

200

Agent application is alive.

Body

application/json

servicesobject

statusV3HealthStatus (enum)

Application health status.

UPDOWN

usersobject

versionstring

Required Agent verison

Request

JavaScriptCurlPython

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

Response

200

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