Update agent policy by ID

PUT /api/fleet/agent_policies/{agentPolicyId}
Api key auth Basic auth

Spaces method and path for this operation:

put /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}

Refer to Spaces for more information.

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.

application/json

Body

  • agent_features array[object]
    Hide agent_features attributes Show agent_features attributes object
    • enabled boolean Required
    • name string Required
  • data_output_id string | null
  • description string
  • download_source_id string | null
  • fleet_server_host_id string | null
  • force boolean

    Force agent policy creation even if packages are not verified.

  • global_data_tags array[object]

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

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

  • inactivity_timeout integer
  • is_protected boolean
  • monitoring_enabled array[string]

    Values are metrics or logs.

  • monitoring_output_id string | null
  • name string Required
  • namespace string Required
  • unenroll_timeout integer

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • item object Required
      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

      • 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.

        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
        Hide monitoring_diagnostics attributes Show monitoring_diagnostics attributes object
        • limit object
          Hide limit attributes Show limit attributes object
          • burst number
          • interval string
        • uploader object
          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
        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.

      • 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

          One of:
          array-1 array object-2 object
        • inputs array[object] Required
          Hide inputs attributes Show inputs attributes object
          • config object
          • enabled boolean Required
          • processors array[string]
          • streams array
          • type string Required
          • vars object
        • revision number Required
        • description string
        • enabled boolean
        • name string Required
        • namespace string
        • output_id string
        • overrides object
        • package object
          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

    Generic Error

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode number
PUT /api/fleet/agent_policies/{agentPolicyId} 
curl \
 --request PUT 'http://localhost:5601/api/fleet/agent_policies/{agentPolicyId}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: string" \
 --data '{"agent_features":[{"enabled":true,"name":"string"}],"data_output_id":"string","description":"string","download_source_id":"string","fleet_server_host_id":"string","force":true,"global_data_tags":[{}],"inactivity_timeout":42,"is_protected":true,"monitoring_enabled":["metrics"],"monitoring_output_id":"string","name":"string","namespace":"string","unenroll_timeout":42}'