Update a managed integration

Base URL
https://{kibana_url}
Auth

Update a managed integration by ID. Uses full-replace semantics: the policy is rebuilt entirely from the request body, so any omitted optional field (for example, description, vars, global_data_tags, cloud_connector) is cleared or reset to its default. The integration package name is immutable and the runtime-managed cluster_id is preserved from the existing policy.

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.

policyId string · max length: 256 required

The ID of the managed integration to update.

Header parameters

kbn-xsrf string required

A required header to protect against CSRF attacks

Request body

additional_datastreams_permissions string[] · max items: 100 nullable

Additional data stream permissions that will be added to the agent policy.

cloud_connector object nullable
cloud_connector_id string · max length: 256

ID of an existing cloud connector to reuse. If not provided, a new connector is created. Requires enabled: true and cannot be combined with name.

enabled boolean · default: false

Set to true to attach a cloud connector to this policy. Must be true to set any of cloud_connector_id, name, or target_csp.

name string · min length: 1 · max length: 255

Name for a new cloud connector. If not provided, a name is generated automatically from the credentials. Requires enabled: true and only applies when creating a new connector (cannot be combined with cloud_connector_id).

target_csp enum

Target cloud service provider. If not provided, the provider is detected automatically from the inputs. Requires enabled: true.

Values: aws azure gcp
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.

global_data_tags object[] · max items: 100
name string · max length: 1024 required

Name of the custom field. The name cannot contain spaces.

value union string | number required

Value of the custom field.

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.

<string> object
condition string · max length: 10000 nullable

Agent condition expression to evaluate whether to apply this input.

deprecated object
description string · max length: 4096 required
replaced_by map string to string
<string> string · max length: 1024
since string · max length: 50
enabled boolean

Enable or disable that input. Defaults to true (enabled).

streams map string to object

Input streams. Refer to the integration documentation to know which streams are available.

<string> object
condition string · max length: 10000 nullable

Agent condition expression to evaluate whether to apply this stream.

deprecated object
description string · max length: 4096 required
replaced_by map string to string
<string> string · max length: 1024
since string · max length: 50
enabled boolean

Enable or disable that stream. Defaults to true (enabled).

var_group_selections map string to string

Variable group selections. Maps var_group name to the selected option name within that group.

<string> string · max length: 1024
vars map string to anyOf

Input/stream level variable. Refer to the integration documentation for more information.

vars map string to anyOf

Input/stream level variable. Refer to the integration documentation for more information.

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.

package object required
experimental_data_stream_features object[] · max items: 100
data_stream string · max length: 1024 required
features object required
doc_value_only_numeric boolean
doc_value_only_other boolean
synthetic_source boolean
tsdb boolean
fips_compatible boolean
name string · max length: 255 required

Package name

requires_root boolean
title string · max length: 255
version string · max length: 50 required

Package version

policy_template string · max length: 256

The policy template to use for the managed integration. If not provided, the default policy template is used.

var_group_selections map string to string

Variable group selections. Maps var_group name to the selected option name within that group.

<string> string · max length: 1024
vars map string to anyOf

Input/stream level variable. Refer to the integration documentation for more information.

Responses

Indicates a successful response

application/json
item object required
additional_datastreams_permissions string[] · max items: 1000

Additional data stream permissions granted to the managed integration.

cloud_connector object
cloud_connector_id string · max length: 255 required

The ID of the cloud connector.

enabled boolean required

Whether the cloud connector is active for this policy.

created_at string · max length: 64 required

Creation timestamp (ISO 8601).

created_by string · max length: 1024 required

User who created the policy.

description string · max length: 2048

Managed integration description.

global_data_tags object[] · max items: 100

Custom data tags applied to all data produced by this policy.

name string · max length: 1024 required

The name of the custom field.

value union string | number required

The value of the custom field.

id string · max length: 255 required

Managed integration unique identifier.

inputs map string to object required

Package policy inputs. Refer to the integration documentation to know which inputs are available.

<string> object
condition string · max length: 10000 nullable

Agent condition expression to evaluate whether to apply this input.

deprecated object
description string · max length: 4096 required
replaced_by map string to string
<string> string · max length: 1024
since string · max length: 50
enabled boolean

Enable or disable that input. Defaults to true (enabled).

streams map string to object

Input streams. Refer to the integration documentation to know which streams are available.

<string> object
condition string · max length: 10000 nullable

Agent condition expression to evaluate whether to apply this stream.

deprecated object
description string · max length: 4096 required
replaced_by map string to string
<string> string · max length: 1024
since string · max length: 50
enabled boolean

Enable or disable that stream. Defaults to true (enabled).

var_group_selections map string to string

Variable group selections. Maps var_group name to the selected option name within that group.

<string> string · max length: 1024
vars map string to anyOf

Input/stream level variable. Refer to the integration documentation for more information.

vars map string to anyOf

Input/stream level variable. Refer to the integration documentation for more information.

name string · max length: 255 required

Managed integration name.

namespace string · max length: 100

Policy namespace. Defaults to the agent policy namespace.

package object required
name string · max length: 255 required

Integration package name.

title string · max length: 255 required

Integration package display title.

version string · max length: 50 required

Integration package version.

updated_at string · max length: 64 required

Last update timestamp (ISO 8601).

updated_by string · max length: 1024 required

User who last updated the policy.

var_group_selections map string to string

Variable group selections. Maps var_group name to the selected option name within that group.

<string> string · max length: 1024
vars map string to anyOf

Input/stream level variable. Refer to the integration documentation for more information.

Bad Request

application/json
attributes object required
error string
errorType string
message string required
statusCode number

Not Found

application/json
message string required

Conflict — for example, the requested name is already used by another integration policy.

application/json
attributes object required
error string
errorType string
message string required
statusCode number
Base URL
https://{kibana_url}