Get an agent

Server: https://{kibana_url}

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

Api key auth Basic auth

Refer to Spaces for more information.

Get an agent by ID.

[Required authorization] Route required privileges: fleet-agents-read.

Path Parameters

agentId string required: The agent ID

Query Parameters

withMetrics boolean · default: false: When true, include CPU and memory metrics in the response

Responses

Successful response

application/json

Bad Request

application/json

404

Not Found

application/json

Examples

Agent details

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/fleet/agents/{agentId}

curl Shell

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

Response

{
  "item": {
    "active": true,
    "agent_id": "agent-id-1",
    "enrolled_at": "2024-01-01T00:00:00.000Z",
    "id": "agent-id-1",
    "local_metadata": {
      "elastic": {
        "agent": {
          "version": "8.17.0"
        }
      },
      "host": {
        "hostname": "my-host"
      },
      "os": {
        "name": "linux"
      }
    },
    "policy_id": "agent-policy-id-1",
    "policy_revision": 1,
    "status": "online",
    "type": "PERMANENT",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

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

{
  "error": "Not Found",
  "message": "Agent agent-id-1 not found",
  "statusCode": 404
}