Dry run a package policy upgrade

Server: https://{kibana_url}

POST /api/fleet/package_policies/upgrade/dryrun
POST /s/{space_id}/api/fleet/package_policies/upgrade/dryrun

Refer to Spaces for more information.

Preview the changes that would be applied by upgrading a package policy to a newer package version.

[Required authorization] Route required privileges: fleet-agent-policies-read AND integrations-read.

Request

Responses

Successful response

application/json

Bad Request

application/json

Examples

Dry run an upgrade of a package policy

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/package_policies/upgrade/dryrun
{
  "packagePolicyIds": [
    "package-policy-id-1"
  ]
}

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/package_policies/upgrade/dryrun" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "packagePolicyIds": [
    "package-policy-id-1"
  ]
}'

Response

[
  {
    "diff": [
      {
        "id": "package-policy-id-1",
        "name": "nginx-1",
        "package": {
          "name": "nginx",
          "version": "1.20.0"
        }
      },
      {
        "name": "nginx-1",
        "package": {
          "name": "nginx",
          "version": "1.21.0"
        }
      }
    ],
    "hasErrors": false,
    "name": "nginx-1"
  }
]

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

Request { packagePolicyIds , packageVersion , }

Responses

Request