Get outputs for agent policies

Base URL: https://{kibana_url}

POST /api/fleet/agent_policies/outputs
POST /s/{space_id}/api/fleet/agent_policies/outputs

Auth

Get a list of outputs associated with agent policies.

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.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

ids string[] · max items: 1000 required: list of package policy ids

Responses

Successful response

application/json

items object[] · max items: 10000 required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Get outputs for multiple agent policies

Console Kibana Dev Tools

POST kbn:/api/fleet/agent_policies/outputs
{
  "ids": [
    "agent-policy-id-1",
    "agent-policy-id-2"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agent_policies/outputs" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "agent-policy-id-1",
      "agent-policy-id-2"
    ]
  }'

Generated from the API spec

Response

Outputs associated with the requested agent policies

{
  "items": [
    {
      "agent_policy_id": "agent-policy-id-1",
      "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
}