Deprecated: Preview a managed integrations upgrade

Base URL
https://{kibana_url}
  • POST /api/fleet/agentless_policies/_upgrade/dryrun
Auth

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.

Header parameters

kbn-xsrf string required

A required header to protect against CSRF attacks

Request body

pkgVersion string · max length: 256

Target package version to preview the upgrade against. Defaults to the installed package version.

policyIds string[] · max items: 1000 required

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.

application/json
<array> object[] · max items: 10000
body object
message string · max length: 4096 required

Error message when the dry-run failed for this policy.

currentVersion string · max length: 256

The current installed package version of the policy.

errors object[] · max items: 1000

Migration errors encountered while computing the upgrade.

message string · max length: 4096 required

Human-readable migration error.

hasErrors boolean required

Whether the dry-run migration produced any errors.

id string · max length: 256 required

The ID of the managed integration.

name string · max length: 256

The name of the managed integration.

proposedPolicy object
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.

proposedVersion string · max length: 256

The package version the policy would be upgraded to.

statusCode number

HTTP-like status code when the dry-run failed for this policy.

Bad Request

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