Get an agent

Base URL: https://{kibana_url}

GET /api/fleet/agents/{agentId}

Get an agent by ID.

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>

Path parameters

Query parameters

Responses

Successful response

application/json

item object required

Bad Request

application/json

404

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agents/AGENT_ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Agent details

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