Download an agent policy

Base URL: https://{kibana_url}

GET /api/fleet/agent_policies/{agentPolicyId}/download

Auth

Download an agent policy by ID.

Required privileges

Privileges fleet-agent-policies-read or fleet-setup

Path parameters

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 — returns the agent policy as a YAML file download

application/json

Response Type: string

Bad Request

application/json

Not Found

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agent_policies/AGENT_POLICY_ID/download

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The agent policy download response

{
  "item": "id: agent-policy-id-1\\nrevision: 1\\noutputs:\\n  default:\\n    type: elasticsearch\\n    hosts:\\n      - https://elasticsearch.example.com:9200\\n"
}

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

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