Preview a managed integrations upgrade

Server: https://{kibana_url}

POST /api/fleet/managed_integrations/_upgrade/dryrun
POST /s/{space_id}/api/fleet/managed_integrations/_upgrade/dryrun

Refer to Spaces for more information.

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

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

Bad Request

application/json

Examples

Preview the upgrade of managed integrations to their installed package version

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/managed_integrations/_upgrade/dryrun" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "policyIds": [
    "d52a7812-5736-4fdc-aed8-72152afa1ffa"
  ]
}'

Response

[
  {
    "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
}

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