Deprecated: Preview a managed integrations upgrade
https://{kibana_url}
- POST /api/fleet/agentless_policies/_upgrade/dryrun
- POST /s/{space_id}/api/fleet/agentless_policies/_upgrade/dryrun
Refer to Spaces for more information.
Deprecated. Use POST /api/fleet/managed_integrations/_upgrade/dryrun instead. Preview upgrading multiple managed integrations without applying any change. Targets the installed package version by default; pass pkgVersion to preview a specific (for example, not-yet-installed) version. Each result returns the current/proposed version and any migration errors, plus — only on a clean dry-run (hasErrors: false) — the migrated proposedPolicy. proposedPolicy is for the edit-and-upgrade flow (edit it, then save via the update (PUT) endpoint); to apply an upgrade as-is, use _upgrade.
Request
-
pkgVersionstring · max: 256 -
Target package version to preview the upgrade against. Defaults to the installed package version.
-
policyIdsstring · max: 1000required -
IDs of the managed integrations to preview upgrading.
Responses
Indicates a successful response. Each clean item (hasErrors: false) previews the migrated policy as a consumable managed integration (proposedPolicy); a missing id, an id that is not a managed integration, or a migration error, is reported as a per-item failure (hasErrors: true, with proposedPolicy omitted) without failing the batch. Inspect every item.
Response Type: object · max: 10000
-
bodyobject -
messagestring · max: 4096required -
Error message when the dry-run failed for this policy.
-
currentVersionstring · max: 256 -
The current installed package version of the policy.
-
errorsobject · max: 1000 -
Migration errors encountered while computing the upgrade.
-
messagestring · max: 4096required -
Human-readable migration error.
-
hasErrorsbooleanrequired -
Whether the dry-run migration produced any errors.
-
idstring · max: 256required -
The ID of the managed integration.
-
namestring · max: 256 -
The name of the managed integration.
-
proposedPolicy -
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.
-
packagerequired -
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.
-
proposedVersionstring · max: 256 -
The package version the policy would be upgraded to.
-
statusCodenumber -
HTTP-like status code when the dry-run failed for this policy.
Bad Request
-
attributesobjectrequired -
errorstring -
errorTypestring -
messagestringrequired -
statusCodenumber