List agents

GET /api/fleet/agents

Query parameters

perPage integer

The number of items to return

Default value is 20.
page integer

Default value is 1.
kuery string
showInactive boolean
showUpgradeable boolean
sortField string Deprecated
sortOrder string

Values are asc or desc.
withMetrics boolean

Return agent metrics, false by default
getStatusSummary boolean

Responses

200 application/json; Elastic-Api-Version=2023-10-31

OK
Hide response attributes Show response attributes object
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  access_api_key string
  
  access_api_key_id string
  
  active boolean Required
  
  components array[object]
  
  Hide components attributes Show components attributes object
  
  id string
  
  message string
  
  status string
  
  Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.
  
  type string
  
  units array[object]
  
  Hide units attributes Show units attributes object
  
  id string
  
  message string
  
  payload object
  
  Additional properties are allowed.
  
  status string
  
  Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.
  
  type string
  
  Values are input or output.
  
  default_api_key string
  
  default_api_key_id string
  
  enrolled_at string Required
  
  id string Required
  
  last_checkin string
  
  local_metadata object
  
  Additional properties are allowed.
  
  metrics object
  
  Additional properties are allowed.
  
  Hide metrics attributes Show metrics attributes object
  
  cpu_avg number
  
  Average agent CPU usage during the last 5 minutes, number between 0-1
  
  memory_size_byte_avg number
  
  Average agent memory consumption during the last 5 minutes
  
  policy_id string
  
  policy_revision number
  
  status string Required
  
  Values are offline, error, online, inactive, or warning.
  
  type string Required
  
  Values are PERMANENT, EPHEMERAL, or TEMPORARY.
  
  unenrolled_at string
  
  unenrollment_started_at string
  
  user_provided_metadata object
  
  Additional properties are allowed.
- list array[object] Deprecated
  
  Hide list attributes Show list attributes object
  
  access_api_key string
  
  access_api_key_id string
  
  active boolean Required
  
  components array[object]
  
  Hide components attributes Show components attributes object
  
  id string
  
  message string
  
  status string
  
  Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.
  
  type string
  
  units array[object]
  
  Hide units attributes Show units attributes object
  
  id string
  
  message string
  
  payload object
  
  Additional properties are allowed.
  
  status string
  
  Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.
  
  type string
  
  Values are input or output.
  
  default_api_key string
  
  default_api_key_id string
  
  enrolled_at string Required
  
  id string Required
  
  last_checkin string
  
  local_metadata object
  
  Additional properties are allowed.
  
  metrics object
  
  Additional properties are allowed.
  
  Hide metrics attributes Show metrics attributes object
  
  cpu_avg number
  
  Average agent CPU usage during the last 5 minutes, number between 0-1
  
  memory_size_byte_avg number
  
  Average agent memory consumption during the last 5 minutes
  
  policy_id string
  
  policy_revision number
  
  status string Required
  
  Values are offline, error, online, inactive, or warning.
  
  type string Required
  
  Values are PERMANENT, EPHEMERAL, or TEMPORARY.
  
  unenrolled_at string
  
  unenrollment_started_at string
  
  user_provided_metadata object
  
  Additional properties are allowed.
- page number Required
- perPage number Required
- statusSummary object
  
  Additional properties are allowed.
  
  Hide statusSummary attributes Show statusSummary attributes object
  
  degraded' number
  
  enrolling number
  
  error number
  
  inactive number
  
  offline number
  
  online number
  
  unenrolled number
  
  unenrolling number
  
  updating number
- total number Required
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

GET /api/fleet/agents

curl \
 -X GET https://localhost:5601/api/fleet/agents

Response examples (200)

{
  "items": [
    {
      "access_api_key": "string",
      "access_api_key_id": "string",
      "active": true,
      "components": [
        {
          "id": "string",
          "message": "string",
          "status": "starting",
          "type": "string",
          "units": [
            {
              "id": "string",
              "message": "string",
              "payload": {},
              "status": "starting",
              "type": "input"
            }
          ]
        }
      ],
      "default_api_key": "string",
      "default_api_key_id": "string",
      "enrolled_at": "string",
      "id": "string",
      "last_checkin": "string",
      "local_metadata": {},
      "metrics": {
        "cpu_avg": 42.0,
        "memory_size_byte_avg": 42.0
      },
      "policy_id": "string",
      "policy_revision": 42.0,
      "status": "offline",
      "type": "PERMANENT",
      "unenrolled_at": "string",
      "unenrollment_started_at": "string",
      "user_provided_metadata": {}
    }
  ],
  "list": [
    {
      "access_api_key": "string",
      "access_api_key_id": "string",
      "active": true,
      "components": [
        {
          "id": "string",
          "message": "string",
          "status": "starting",
          "type": "string",
          "units": [
            {
              "id": "string",
              "message": "string",
              "payload": {},
              "status": "starting",
              "type": "input"
            }
          ]
        }
      ],
      "default_api_key": "string",
      "default_api_key_id": "string",
      "enrolled_at": "string",
      "id": "string",
      "last_checkin": "string",
      "local_metadata": {},
      "metrics": {
        "cpu_avg": 42.0,
        "memory_size_byte_avg": 42.0
      },
      "policy_id": "string",
      "policy_revision": 42.0,
      "status": "offline",
      "type": "PERMANENT",
      "unenrolled_at": "string",
      "unenrollment_started_at": "string",
      "user_provided_metadata": {}
    }
  ],
  "page": 42.0,
  "perPage": 42.0,
  "statusSummary": {
    "degraded'": 42.0,
    "enrolling": 42.0,
    "error": 42.0,
    "inactive": 42.0,
    "offline": 42.0,
    "online": 42.0,
    "unenrolled": 42.0,
    "unenrolling": 42.0,
    "updating": 42.0
  },
  "total": 42.0
}

Response examples (400)

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