Create a managed integration
https://{kibana_url}
- POST /api/fleet/managed_integrations
- POST /s/{space_id}/api/fleet/managed_integrations
Refer to Spaces for more information.
Create a managed integration
Request
-
additional_datastreams_permissionsstring · max: 100nullable -
Additional data stream permissions that will be added to the agent policy.
-
cloud_connectorobjectnullable -
cloud_connector_idstring · max: 256 -
ID of an existing cloud connector to reuse. If not provided, a new connector is created. Requires
enabled: trueand cannot be combined withname. -
enabledboolean · default: false -
Set to
trueto attach a cloud connector to this policy. Must betrueto set any ofcloud_connector_id,name, ortarget_csp. -
namestring · min: 1 · max: 255 -
Name for a new cloud connector. If not provided, a name is generated automatically from the credentials. Requires
enabled: trueand only applies when creating a new connector (cannot be combined withcloud_connector_id). -
target_csp -
Target cloud service provider. If not provided, the provider is detected automatically from the inputs. Requires
enabled: true. -
Values:
awsazuregcp -
create_dataset_templatesboolean -
When true, install dedicated index templates for streams with a custom data_stream.dataset. Defaults to true for input packages, false for integration packages.
-
descriptionstring · max: 2048 -
Policy description.
-
forceboolean -
Force package policy creation even if the package is not verified, or if the agent policy is managed.
-
Name of the custom field. The name cannot contain spaces.
-
Value of the custom field.
-
idstring · max: 255 -
Policy unique identifier.
-
inputsmap string to object -
Package policy inputs. Refer to the integration documentation to know which inputs are available.
-
<string>object -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this input.
-
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledboolean -
Enable or disable that input. Defaults to
true(enabled). -
streamsmap string to object -
Input streams. Refer to the integration documentation to know which streams are available.
-
<string>object -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this stream.
-
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledboolean -
Enable or disable that stream. Defaults to
true(enabled). -
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
-
namestring · max: 255required -
Unique name for the policy.
-
namespacestring · max: 100 -
Policy namespace. When not specified, it inherits the agent policy namespace.
-
package -
experimental_data_stream_featuresobject · max: 100 -
data_streamstring · max: 1024required -
featuresobjectrequired -
doc_value_only_numericboolean -
doc_value_only_otherboolean -
synthetic_sourceboolean -
tsdbboolean -
fips_compatibleboolean -
namestring · max: 255required -
Package name
-
requires_rootboolean -
titlestring · max: 255 -
versionstring · max: 50required -
Package version
-
policy_templatestring · max: 256 -
The policy template to use for the managed integration. If not provided, the default policy template is used.
-
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
Responses
Indicates a successful response
-
item -
additional_datastreams_permissionsstring · max: 1000 -
Additional data stream permissions granted to the managed integration.
-
cloud_connector -
cloud_connector_idstring · max: 255required -
The ID of the cloud connector.
-
enabledbooleanrequired -
Whether the cloud connector is active for this policy.
-
created_atstring · max: 64required -
Creation timestamp (ISO 8601).
-
created_bystring · max: 1024required -
User who created the policy.
-
descriptionstring · max: 2048 -
Managed integration description.
-
Custom data tags applied to all data produced by this policy.
-
The name of the custom field.
-
The value of the custom field.
-
idstring · max: 255required -
Managed integration unique identifier.
-
inputsmap string to objectrequired -
Package policy inputs. Refer to the integration documentation to know which inputs are available.
-
<string>object -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this input.
-
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledboolean -
Enable or disable that input. Defaults to
true(enabled). -
streamsmap string to object -
Input streams. Refer to the integration documentation to know which streams are available.
-
<string>object -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this stream.
-
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledboolean -
Enable or disable that stream. Defaults to
true(enabled). -
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
-
namestring · max: 255required -
Managed integration name.
-
namespacestring · max: 100 -
Policy namespace. Defaults to the agent policy namespace.
-
package -
updated_atstring · max: 64required -
Last update timestamp (ISO 8601).
-
updated_bystring · max: 1024required -
User who last updated the policy.
-
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
Bad Request
-
attributesobjectrequired -
errorstring -
errorTypestring -
messagestringrequired -
statusCodenumber
Conflict
-
attributesobjectrequired -
errorstring -
errorTypestring -
messagestringrequired -
statusCodenumber