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

get

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

Agent application is alive.