Get an agent policy

Base URL: https://{kibana_url}

GET /api/fleet/agent_policies/{agentPolicyId}
GET /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}

Refer to Spaces for more information.

Get an agent policy 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/agent_policies/AGENT_POLICY_ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

An agent policy

{
  "item": {
    "description": "A sample agent policy",
    "id": "agent-policy-id-1",
    "is_managed": false,
    "is_protected": false,
    "name": "My agent policy",
    "namespace": "default",
    "revision": 1,
    "status": "active",
    "updated_at": "2024-01-15T10:00:00.000Z",
    "updated_by": "user1"
  }
}

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

{
  "error": "Not Found",
  "message": "Agent policy not found",
  "statusCode": 404
}