Sign in
Elastic Agent policies

Update an agent policy

Spaces method and path for this operation:

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/fleet/agent_policies/{agentPolicyId}</span></div>

Refer to Spaces for more information.

Update an agent policy by ID.<br/><br/>[Required authorization] Route required privileges: fleet-agent-policies-all.

put/api/fleet/agent_policies/{agentPolicyId}

Path parameters

agentPolicyIdstring required

The ID of the agent policy

Query parameters

format'simplified' | 'legacy'

Format for the response: simplified or legacy

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

bumpRevisionboolean
data_output_idstring nullable
descriptionstring
download_source_idstring nullable

Use download_source_ids instead

download_source_idsstring[]
fleet_server_host_idstring nullable
forceboolean
has_agent_version_conditionsboolean
has_fleet_serverboolean
idstring
inactivity_timeoutnumber
is_defaultboolean
is_default_fleet_serverboolean
is_managedboolean
is_protectedboolean
is_verifierboolean
keep_monitoring_aliveboolean nullable

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

min_agent_versionstring nullable
monitoring_enabledstring[]
monitoring_output_idstring nullable
monitoring_pprof_enabledboolean
namestring required
namespacestring required
overridesobject nullable

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.

space_idsstring[]
supports_agentlessboolean nullable

Indicates whether the agent policy supports agentless integrations. Deprecated in favor of the Fleet managed integrations API.

unenroll_timeoutnumber

Response

Successful response

Changes

Changed in 1 of the 176 revisions of this API.4

  • 18986b50fb8e4See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      request property deprecated

      request-property-deprecated

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      response property item/download_source_id deprecated

      response-property-deprecated

Of the 176 revisions, 20 have no diff computed.