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

Agent application is alive.

Body
servicesobject
statusV3HealthStatus (enum)

Application health status.

UPDOWN
usersobject
versionstring

Required Agent verison

Request
const response = await fetch('youragentURL.symphony.com/agent/v3/health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "status": "UP",
  "version": "text"
}

Last updated