Get outputs for an agent policy

Base URL: https://{kibana_url}

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

Auth

Get a list of outputs associated with agent policy by policy id.

Required privileges

Privileges fleet-agent-policies-read and fleet-settings-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 · min length: 0 required: The ID of the agent policy

Responses

Successful response

application/json

item object required

Bad Request

application/json

404

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

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Outputs associated with the agent policy

{
  "item": {
    "data_output": {
      "id": "output-id-1",
      "name": "Default output",
      "type": "elasticsearch"
    },
    "monitoring_output": {
      "id": "output-id-1",
      "name": "Default output",
      "type": "elasticsearch"
    }
  }
}

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

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