GET /api/fleet/agent_policies/{agentPolicyId}/outputs
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

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

[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-settings-read.

Path parameters

  • agentPolicyId string Required

    The ID of the agent policy

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • agentPolicyId string
      • data object Required

        Additional properties are NOT allowed.

        Hide data attributes Show data attributes object
        • integrations array[object]

          Not more than 1000 elements.

          Hide integrations attributes Show integrations attributes object
          • id string
          • integrationPolicyName string
          • name string
          • pkgName string
        • output object Required

          Additional properties are NOT allowed.

          Hide output attributes Show output attributes object
          • id string Required
          • name string Required
      • monitoring object Required

        Additional properties are NOT allowed.

        Hide monitoring attribute Show monitoring attribute object
        • output object Required

          Additional properties are NOT allowed.

          Hide output attributes Show output attributes object
          • id string Required
          • name string Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
  • 404 application/json

    Not Found

GET /api/fleet/agent_policies/{agentPolicyId}/outputs 
curl \
 --request GET 'https://localhost:5601/api/fleet/agent_policies/{agentPolicyId}/outputs' \
 --header "Authorization: $API_KEY"
Response examples (200)
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"
    }
  }
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}
Response examples (404)
No agent policy was found with the given ID 
{
  "error": "Not Found",
  "message": "Agent policy not found",
  "statusCode": 404
}