Get an agent status summary | Kibana Serverless API

Get an agent status summary Beta

GET /api/fleet/agent_status

Headers

elastic-api-version string

The version of the API to use

Value is 2023-10-31. Default value is 2023-10-31.

Query parameters

policyId string
policyIds array[string] | string
kuery string

Responses

200 application/json; Elastic-Api-Version=2023-10-31
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
  
  other number Required
  
  unenrolled number Required
  
  updating number Required
400 application/json; Elastic-Api-Version=2023-10-31
Hide response attributes Show response attributes object
- error string
- message string Required
- statusCode number

GET /api/fleet/agent_status

curl \
 -X GET https://localhost:5601/api/fleet/agent_status \
 -H "elastic-api-version: 2023-10-31"

Response examples (200)

{
  "results": {
    "active": 42.0,
    "all": 42.0,
    "error": 42.0,
    "events": 42.0,
    "inactive": 42.0,
    "offline": 42.0,
    "online": 42.0,
    "other": 42.0,
    "unenrolled": 42.0,
    "updating": 42.0
  }
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}