GET /api/fleet/agent_status
Api key auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/agent_status

Refer to Spaces for more information.

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

Query parameters

  • policyId string
  • policyIds array[string]

    Not more than 1000 elements.

  • kuery string

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • results object Required

      Additional properties are NOT allowed.

      Hide results attributes Show results attributes object
      • active number Required
      • all number Required
      • error number Required
      • events number Required
      • inactive number Required
      • offline number Required
      • online number Required
      • orphaned number
      • other number Required
      • unenrolled number Required
      • uninstalled number
      • updating number Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/agent_status 
curl \
 --request GET 'https://<KIBANA_URL>/api/fleet/agent_status' \
 --header "Authorization: $API_KEY"
Response examples (200)
Agent status summary for an agent policy 
{
  "results": {
    "error": 1,
    "offline": 2,
    "online": 5,
    "other": 0,
    "updating": 0
  },
  "totalInactive": 0
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}