Headers

• kbn-xsrf string Required

  Kibana's anti Cross-Site Request Forgery token. Can be any string value.

Path parameters

• agentPolicyId string Required

Query parameters

• format string

  Simplified or legacy format for package inputs

  Values are simplified or legacy.

Responses

• 200 application/json; Elastic-Api-Version=2023-10-31

  OK

  Hide response attribute Show response attribute object

  • item object Required

    Additional properties are allowed.

    Hide item attributes Show item attributes object

    • advanced_settings object | null

      Advanced settings stored in the agent policy, e.g. agent_limits_go_max_procs

      Additional properties are allowed.

    • agent_features array[object]
      Hide agent_features attributes Show agent_features attributes object

      • enabled boolean Required
      • name string Required
    • agents number
    • data_output_id string | null
    • description string
    • download_source_id string | null
    • fleet_server_host_id string | null
    • global_data_tags array[object]

      User defined data tags that are added to all of the inputs. The values can be strings or numbers.

    • id string Required
    • inactivity_timeout integer
    • is_protected boolean

      Indicates whether the agent policy has tamper protection enabled. Default false.

    • keep_monitoring_alive boolean | null

      When set to true, monitoring will be enabled but logs/metrics collection will be disabled

    • monitoring_diagnostics object

      Additional properties are allowed.

      Hide monitoring_diagnostics attributes Show monitoring_diagnostics attributes object

      • limit object

        Additional properties are allowed.

        Hide limit attributes Show limit attributes object

        • burst number
        • interval string
      • uploader object

        Additional properties are allowed.

        Hide uploader attributes Show uploader attributes object

        • init_dur string
        • max_dur string
        • max_retries number
    • monitoring_enabled array[string]

      Values are metrics or logs.

    • monitoring_http object

      Additional properties are allowed.

      Hide monitoring_http attributes Show monitoring_http attributes object

      • enabled boolean Required
      • host string
      • port number
    • monitoring_output_id string | null
    • monitoring_pprof_enabled boolean
    • name string Required
    • namespace string Required
    • overrides object | null

      Override settings that are defined in the agent policy. Input settings cannot be overridden. The override option should be used only in unusual circumstances and not as a routine procedure.

      Additional properties are allowed.

    • package_policies array[object]

      This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter

      Hide package_policies attributes Show package_policies attributes object

      • id string Required
      • inputs array[object] Required
        Hide inputs attributes Show inputs attributes object

        • config object

          Additional properties are allowed.

        • enabled boolean Required
        • processors array[string]
        • streams array
        • type string Required
        • vars object

          Additional properties are allowed.

      • revision number Required
      • description string
      • enabled boolean
      • name string Required
      • namespace string
      • output_id string
      • overrides object

        Additional properties are allowed.

      • package object

        Additional properties are allowed.

        Hide package attributes Show package attributes object

        • name string Required
        • requires_root boolean
        • title string
        • version string Required
      • policy_id string | null Deprecated
      • policy_ids array[string]
    • revision number
    • supports_agentless boolean

      Indicates whether the agent policy supports agentless integrations. Only allowed in a serverless environment.

    • unenroll_timeout integer
    • unprivileged_agents number
    • updated_by string
    • updated_on string(date-time)
• 400 application/json; Elastic-Api-Version=2023-10-31

  Generic Error

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode number