Get an agent status summary

Base URL: https://{kibana_url}

GET /api/fleet/agent_status

Get a summary of agent statuses for a given agent policy.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agent_status

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/agent_status" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Agent status summary for an agent policy

{
  "results": {
    "error": 1,
    "offline": 2,
    "online": 5,
    "other": 0,
    "updating": 0
  },
  "totalInactive": 0
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}