Deprecated: Preview a managed integrations upgrade
Base URL
https://{kibana_url}
POST/api/fleet/agentless_policies/_upgrade/dryrun
AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityExperimental since 9.5This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply.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.
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.
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.
application/json
<array>object[] · max items: 10000
bodyobject
messagestring · max length: 4096required
Error message when the dry-run failed for this policy.
currentVersionstring · max length: 256
The current installed package version of the policy.
errorsobject[] · max items: 1000
Migration errors encountered while computing the upgrade.
messagestring · max length: 4096required
Human-readable migration error.
hasErrorsbooleanrequired
Whether the dry-run migration produced any errors.
idstring · max length: 256required
The ID of the managed integration.
namestring · max length: 256
The name of the managed integration.
proposedPolicyobject
additional_datastreams_permissionsstring[] · max items: 1000
Additional data stream permissions granted to the managed integration.
cloud_connectorobject
cloud_connector_idstring · max length: 255required
The ID of the cloud connector.
enabledbooleanrequired
Whether the cloud connector is active for this policy.
created_atstring · max length: 64required
Creation timestamp (ISO 8601).
created_bystring · max length: 1024required
User who created the policy.
descriptionstring · max length: 2048
Managed integration description.
global_data_tagsobject[] · max items: 100
Custom data tags applied to all data produced by this policy.
namestring · max length: 1024required
The name of the custom field.
valueunionstring | numberrequired
The value of the custom field.
idstring · max length: 255required
Managed integration unique identifier.
inputsmapstring to objectrequired
Package policy inputs. Refer to the integration documentation to know which inputs are available.
<string>object
conditionstring · max length: 10000nullable
Agent condition expression to evaluate whether to apply this input.
deprecatedobject
descriptionstring · max length: 4096required
replaced_bymapstring to string
<string>string · max length: 1024
sincestring · max length: 50
enabledboolean
Enable or disable that input. Defaults to true (enabled).
streamsmapstring to object
Input streams. Refer to the integration documentation to know which streams are available.
<string>object
conditionstring · max length: 10000nullable
Agent condition expression to evaluate whether to apply this stream.
deprecatedobject
descriptionstring · max length: 4096required
replaced_bymapstring to string
<string>string · max length: 1024
sincestring · max length: 50
enabledboolean
Enable or disable that stream. Defaults to true (enabled).
var_group_selectionsmapstring to string
Variable group selections. Maps var_group name to the selected option name within that group.
<string>string · max length: 1024
varsmapstring to anyOf
Input/stream level variable. Refer to the integration documentation for more information.
<string>unionanyOf · default: null
Any of:
string[]
number[]
idstring · max length: 255required
isSecretRefbooleanrequired
varsmapstring to anyOf
Input/stream level variable. Refer to the integration documentation for more information.
<string>unionanyOf · default: null
Any of:
string[]
number[]
idstring · max length: 255required
isSecretRefbooleanrequired
namestring · max length: 255required
Managed integration name.
namespacestring · max length: 100
Policy namespace. Defaults to the agent policy namespace.
packageobjectrequired
namestring · max length: 255required
Integration package name.
titlestring · max length: 255required
Integration package display title.
versionstring · max length: 50required
Integration package version.
updated_atstring · max length: 64required
Last update timestamp (ISO 8601).
updated_bystring · max length: 1024required
User who last updated the policy.
var_group_selectionsmapstring to string
Variable group selections. Maps var_group name to the selected option name within that group.
<string>string · max length: 1024
varsmapstring to anyOf
Input/stream level variable. Refer to the integration documentation for more information.
<string>unionanyOf · default: null
Any of:
string[]
number[]
idstring · max length: 255required
isSecretRefbooleanrequired
proposedVersionstring · max length: 256
The package version the policy would be upgraded to.
statusCodenumber
HTTP-like status code when the dry-run failed for this policy.