Download an agent policy

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

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

application/json

Bad Request

application/json

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