Get agent by ID

Base URL: https://{kibana_url}

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

Auth

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
agentId string required

Query parameters

withMetrics boolean: Return agent metrics, false by default

Responses

OK

application/json

item object required

Generic Error

application/json

View as Markdown

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

{
  "item": {
    "access_api_key": "string",
    "access_api_key_id": "string",
    "active": false,
    "components": [
      {
        "id": "string",
        "message": "string",
        "status": "starting",
        "type": "string",
        "units": [
          {
            "id": "string",
            "message": "string",
            "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": 0,
      "memory_size_byte_avg": 0
    },
    "policy_id": "string",
    "policy_revision": 0,
    "status": "offline",
    "type": "PERMANENT",
    "unenrolled_at": "string",
    "unenrollment_started_at": "string",
    "user_provided_metadata": {}
  }
}

Generated from the API spec

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

Generated from the API spec