Update a package policy

Base URL: https://{kibana_url}

PUT /api/fleet/package_policies/{packagePolicyId}
PUT /s/{space_id}/api/fleet/package_policies/{packagePolicyId}

Auth

Update a package policy by ID.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
packagePolicyId string · min length: 0 required: The ID of the package policy

Query parameters

format enum: Format for the response: simplified or legacy; Values: simplified legacy
onboarding_deployment_id string · max length: 256 The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.: ID of the cloud onboarding instance that manages the package policies. Required to change package policies managed by a cloud onboarding instance; only the onboarding flow is expected to set it. Requests that change a managed package policy without a matching ID are rejected with a 400 error, and force does not bypass this check. A bulk delete that includes such a package policy is rejected as a whole.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

Any of:

additional_datastreams_permissions string[] · max items: 1000 nullable: Additional data stream permissions that will be added to the agent policy.
cloud_connector_id string · min length: 0 nullable: ID of the cloud connector associated with this package policy.
cloud_connector_name string · min length: 1 · max length: 255 nullable: Transient field for cloud connector name during creation.
condition string · max length: 10000 nullable: Agent condition expression to evaluate whether to apply this integration to its inputs.
description string · min length: 0: Package policy description
enabled boolean
force boolean
global_data_tags object[] · max items: 100 nullable
inputs object[] · max items: 1000
is_managed boolean
name string · min length: 0
namespace string · max length: 100: The package policy namespace. Leave blank to inherit the agent policy's namespace.
output_id string · min length: 0 nullable
overrides object nullable: Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
package object
package_agent_version_condition string
policy_id string · min length: 0 nullable deprecated: ID of the agent policy which the package policy will be added to.
policy_ids string[] · max items: 1000
spaceIds string[] · max items: 100
supports_agentless boolean nullable: Indicates whether the package policy belongs to an agentless agent policy.
supports_cloud_connector boolean nullable: Indicates whether the package policy supports cloud connectors.
var_group_selections map string to string: Variable group selections. Maps var_group name to the selected option name within that group.
vars map string to object: Package variable (see integration documentation for more information)
version string

additional_datastreams_permissions string[] · max items: 100 nullable: Additional data stream permissions that will be added to the agent policy.
condition string · max length: 10000 nullable: Agent condition expression to evaluate whether to apply this integration to its inputs.
create_dataset_templates boolean: When true, install dedicated index templates for streams with a custom data_stream.dataset. Defaults to true for input packages, false for integration packages.
description string · max length: 2048: Policy description.
force boolean: Force package policy creation even if the package is not verified, or if the agent policy is managed.
id string · max length: 255: Policy unique identifier.
inputs map string to object: Package policy inputs. Refer to the integration documentation to know which inputs are available.
name string · max length: 255 required: Unique name for the policy.
namespace string · max length: 100: Policy namespace. When not specified, it inherits the agent policy namespace.
output_id string · max length: 255 nullable
package object required: Same fields as package in update_package_policy_request
policy_id string · max length: 255 nullable deprecated: Deprecated. Use policy_ids instead.
policy_ids string[] · max items: 1000: IDs of the agent policies that the package policy will be added to.
supports_agentless boolean nullable deprecated: Indicates whether the package policy belongs to an agentless agent policy. Deprecated in favor of the Fleet managed integrations API.
var_group_selections map string to string: Variable group selections. Maps var_group name to the selected option name within that group.
vars map string to anyOf: Input/stream level variable. Refer to the integration documentation for more information.

Responses

Successful response

application/json

item object required

Bad Request

application/json

Forbidden

application/json