Get an agent status summary

Auth

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

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

policyId string · min length: 0: Filter by agent policy ID
policyIds string[] · max items: 1000: Filter by one or more agent policy IDs
kuery string · min length: 0: A KQL query string to filter results

Successful response

application/json

Bad Request

application/json

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
}