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

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Preview the upgrade of managed integrations to their installed package version

Console Kibana Dev Tools

POST kbn:/api/fleet/agentless_policies/_upgrade/dryrun
{
  "policyIds": [
    "d52a7812-5736-4fdc-aed8-72152afa1ffa"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agentless_policies/_upgrade/dryrun" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "policyIds": [
      "d52a7812-5736-4fdc-aed8-72152afa1ffa"
    ]
  }'

Generated from the API spec

Response

Example dry-run response where migrating the config to the new version produced errors. hasErrors is true and errors explains why; do not feed the (partial) proposed config into the update endpoint without resolving them.

[
  {
    "currentVersion": "1.5.0",
    "errors": [
      {
        "message": "Variable \u0022organization_id\u0022 is required"
      }
    ],
    "hasErrors": true,
    "id": "d52a7812-5736-4fdc-aed8-72152afa1ffa",
    "name": "ess_billing-1",
    "proposedVersion": "1.6.0"
  }
]

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}

Request Console 1 / 2 languages

Preview the upgrade against an explicit target package version (for example, before installing the new version). Defaults to the installed package version when omitted.

Console Kibana Dev Tools

POST kbn:/api/fleet/agentless_policies/_upgrade/dryrun
{
  "pkgVersion": "1.6.0",
  "policyIds": [
    "d52a7812-5736-4fdc-aed8-72152afa1ffa"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agentless_policies/_upgrade/dryrun" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "pkgVersion": "1.6.0",
    "policyIds": [
      "d52a7812-5736-4fdc-aed8-72152afa1ffa"
    ]
  }'

Generated from the API spec

Response

Example dry-run response where migrating the config to the new version produced errors. hasErrors is true and errors explains why; do not feed the (partial) proposed config into the update endpoint without resolving them.

[
  {
    "currentVersion": "1.5.0",
    "errors": [
      {
        "message": "Variable \u0022organization_id\u0022 is required"
      }
    ],
    "hasErrors": true,
    "id": "d52a7812-5736-4fdc-aed8-72152afa1ffa",
    "name": "ess_billing-1",
    "proposedVersion": "1.6.0"
  }
]

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}