Get a full agent policy

Base URL: https://{kibana_url}

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

Auth

Get a full agent policy by ID.

Required authorization

Privileges fleet-agent-policies-read and integrations-read

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.
agentPolicyId string required: The ID of the agent policy

Query parameters

download boolean: If true, returns the policy as a downloadable file
standalone boolean: If true, returns the policy formatted for standalone agents
kubernetes boolean: If true, returns the policy formatted for Kubernetes deployment
revision number: If provided, returns the policy at the specified revision. Cannot be used with standalone or kubernetes flags.

Responses

Successful response

application/json

item union anyOf required: Any of:

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

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/full

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The full agent policy configuration

{
  "item": {
    "agent": {
      "monitoring": {
        "logs": true,
        "metrics": true
      }
    },
    "id": "agent-policy-id-1",
    "inputs": [],
    "outputs": {
      "default": {
        "hosts": [
          "https://elasticsearch.example.com:9200"
        ],
        "type": "elasticsearch"
      }
    },
    "revision": 1
  }
}

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

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