Get agents

Server: 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] Route required privileges: fleet-agents-read.

Query Parameters

Responses

Successful response

application/json

Bad Request

application/json

Examples

List of agents

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/fleet/agents

curl Shell

curl -X GET "https://{kibana_url}/api/fleet/agents"

Response

{
  "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
}

Query Parameters { page , perPage , kuery , showAgentless , showInactive , withMetrics , showUpgradeable , getStatusSummary , sortField , sortOrder , searchAfter , openPit , pitId , pitKeepAlive , }

Responses

Query Parameters