Get agents

Base URL: https://{kibana_url}

GET /api/fleet/agents
GET /s/{space_id}/api/fleet/agents

Refer to Spaces for more information.

List agents, with optional filtering and pagination.

Required authorization

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

items object[] · max items: 10000 required
nextSearchAfter string
page number required
perPage number required
pit string
statusSummary map string to number
total number required

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agents

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

List of agents

{
  "items": [
    {
      "active": true,
      "enrolled_at": "2024-01-01T00:00:00.000Z",
      "id": "agent-id-1",
      "policy_id": "agent-policy-id-1",
      "policy_revision": 1,
      "status": "online",
      "type": "PERMANENT",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 1
}

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