Get a full agent policy

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

Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Get a full agent policy by ID.

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

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

200 application/json

Successful response
Hide response attribute Show response attribute object
- item string | object Required
  
  Any of:
  string-1 string object-2 object
  
  Hide attributes Show attributes
  
  agent object
  
  Additional properties are NOT allowed.
  
  Hide agent attributes Show agent attributes object
  
  download object Required
  
  Additional properties are NOT allowed.
  
  Hide download attributes Show download attributes object
  
  auth object
  
  Additional properties are NOT allowed.
  
  Hide auth attributes Show auth attributes object
  
  api_key string
  
  headers array[object]
  
  Not more than 100 elements.
  
  Hide headers attributes Show headers attributes object
  
  key string Required
  
  value string Required
  
  password string
  
  username string
  
  proxy_headers object | null
  
  proxy_url string
  
  secrets object
  
  Additional properties are allowed.
  
  Hide secrets attribute Show secrets attribute object
  
  ssl object
  
  Additional properties are allowed.
  
  Hide ssl attribute Show ssl attribute object
  
  key object Required
  
  Additional properties are allowed.
  
  Hide key attribute Show key attribute object
  
  id string
  
  sourceURI string Required
  
  ssl object
  
  Additional properties are NOT allowed.
  
  Hide ssl attributes Show ssl attributes object
  
  certificate string
  
  certificate_authorities array[string]
  
  Not more than 10 elements.
  
  key string
  
  renegotiation string
  
  verification_mode string
  
  target_directory string
  
  timeout string
  
  features object Required
  
  Hide features attribute Show features attribute object
  
  * object Additional properties
  
  Additional properties are NOT allowed.
  
  Hide * attribute Show * attribute object
  
  enabled boolean Required
  
  internal Required
  
  limits object
  
  Additional properties are NOT allowed.
  
  Hide limits attribute Show limits attribute object
  
  go_max_procs number
  
  logging object
  
  Additional properties are NOT allowed.
  
  Hide logging attributes Show logging attributes object
  
  files object
  
  Additional properties are NOT allowed.
  
  Hide files attributes Show files attributes object
  
  interval string
  
  keepfiles number
  
  rotateeverybytes number
  
  level string
  
  metrics object
  
  Additional properties are NOT allowed.
  
  Hide metrics attribute Show metrics attribute object
  
  period string
  
  to_files boolean
  
  monitoring object Required
  
  Additional properties are NOT allowed.
  
  Hide monitoring attributes Show monitoring attributes object
  
  _runtime_experimental string
  
  apm Required
  
  diagnostics object
  
  Additional properties are NOT allowed.
  
  Hide diagnostics attributes Show diagnostics attributes object
  
  limit object
  
  Additional properties are NOT allowed.
  
  Hide limit attributes Show limit attributes object
  
  burst number
  
  interval string
  
  uploader object
  
  Additional properties are NOT allowed.
  
  Hide uploader attributes Show uploader attributes object
  
  init_dur string
  
  max_dur string
  
  max_retries number
  
  enabled boolean Required
  
  http object
  
  Additional properties are NOT allowed.
  
  Hide http attributes Show http attributes object
  
  enabled boolean
  
  host string
  
  port number
  
  logs boolean Required
  
  metrics boolean Required
  
  namespace string
  
  pprof object
  
  Additional properties are NOT allowed.
  
  Hide pprof attribute Show pprof attribute object
  
  enabled boolean Required
  
  traces boolean Required
  
  use_output string
  
  protection object
  
  Additional properties are NOT allowed.
  
  Hide protection attributes Show protection attributes object
  
  enabled boolean Required
  
  signing_key string Required
  
  uninstall_token_hash string Required
  
  connectors object
  
  exporters object
  
  extensions object
  
  fleet object
  
  Any of:
  object-1 object object-2 object
  
  Hide attributes Show attributes
  
  hosts array[string] Required
  
  Not more than 100 elements.
  
  proxy_headers object | null
  
  proxy_url string
  
  secrets object
  
  Additional properties are allowed.
  
  Hide secrets attribute Show secrets attribute object
  
  ssl object
  
  Additional properties are allowed.
  
  Hide ssl attribute Show ssl attribute object
  
  key object Required
  
  Additional properties are allowed.
  
  Hide key attribute Show key attribute object
  
  id string
  
  ssl object
  
  Additional properties are NOT allowed.
  
  Hide ssl attributes Show ssl attributes object
  
  certificate string
  
  certificate_authorities array[string]
  
  Not more than 10 elements.
  
  key string
  
  renegotiation string
  
  verification_mode string
  
  Hide attribute Show attribute
  
  kibana object Required
  
  Additional properties are NOT allowed.
  
  Hide kibana attributes Show kibana attributes object
  
  hosts array[string] Required
  
  Not more than 100 elements.
  
  path string
  
  protocol string Required
  
  id string Required
  
  inputs array[object] Required
  
  Not more than 10000 elements.
  
  Hide inputs attributes Show inputs attributes object
  
  data_stream object Required
  
  Additional properties are allowed.
  
  Hide data_stream attribute Show data_stream attribute object
  
  namespace string Required
  
  id string Required
  
  meta object
  
  Additional properties are allowed.
  
  Hide meta attribute Show meta attribute object
  
  package object
  
  Additional properties are allowed.
  
  Hide package attributes Show package attributes object
  
  name string Required
  
  version string Required
  
  name string Required
  
  package_policy_id string Required
  
  processors array[object]
  
  Not more than 10000 elements.
  
  Hide processors attribute Show processors attribute object
  
  add_fields object Required
  
  Additional properties are allowed.
  
  Hide add_fields attributes Show add_fields attributes object
  
  fields object Required
  
  target string Required
  
  revision number Required
  
  streams array[object]
  
  Not more than 10000 elements.
  
  Hide streams attributes Show streams attributes object
  
  data_stream object Required
  
  Additional properties are allowed.
  
  Hide data_stream attributes Show data_stream attributes object
  
  dataset string Required
  
  type string
  
  id string Required
  
  type string Required
  
  use_output string Required
  
  namespaces array[string]
  
  Not more than 100 elements.
  
  output_permissions object
  
  Hide output_permissions attribute Show output_permissions attribute object
  
  * object Additional properties
  
  outputs object Required
  
  Hide outputs attribute Show outputs attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  ca_sha256 string | null
  
  hosts array[string]
  
  Not more than 100 elements.
  
  proxy_headers object | null
  
  proxy_url string
  
  type string Required
  
  processors object
  
  receivers object
  
  revision number
  
  secret_references array[object]
  
  Not more than 10000 elements.
  
  Hide secret_references attribute Show secret_references attribute object
  
  id string Required
  
  service object
  
  Additional properties are NOT allowed.
  
  Hide service attributes Show service attributes object
  
  extensions array[string]
  
  Not more than 1000 elements.
  
  pipelines object
  
  Hide pipelines attribute Show pipelines attribute object
  
  * object Additional properties
  
  Additional properties are NOT allowed.
  
  Hide * attributes Show * attributes object
  
  exporters array[string]
  
  Not more than 1000 elements.
  
  processors array[string]
  
  Not more than 1000 elements.
  
  receivers array[string]
  
  Not more than 1000 elements.
  
  signed object
  
  Additional properties are NOT allowed.
  
  Hide signed attributes Show signed attributes object
  
  data string Required
  
  signature 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}/full

curl \
 --request GET 'https://localhost:5601/api/fleet/agent_policies/{agentPolicyId}/full' \
 --header "Authorization: $API_KEY"

Response examples (200)

The full agent policy configuration

{
  "item": {
    "agent": {
      "monitoring": {
        "logs": true,
        "metrics": true
      }
    },
    "id": "agent-policy-id-1",
    "inputs": [],
    "outputs": {
      "default": {
        "hosts": [
          "https://elasticsearch.example.com:9200"
        ],
        "type": "elasticsearch"
      }
    },
    "revision": 1
  }
}

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
}