Dry run package policy upgrade

Base URL: https://{kibana_url}

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

Auth

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Request body

packagePolicyIds string[] required
packageVersion string

Responses

application/json

<array> object[]

Generic Error

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/package_policies/upgrade/dryrun
{
  "packagePolicyIds": [
    "string"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/package_policies/upgrade/dryrun" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "packagePolicyIds": [
      "string"
    ]
  }'

Generated from the API spec

Response

[
  {
    "agent_diff": [
      [
        {
          "data_stream": {
            "namespace": "string"
          },
          "id": "string",
          "meta": {},
          "name": "string",
          "revision": 0,
          "streams": {
            "id": "string"
          },
          "type": "string",
          "use_output": "string"
        }
      ]
    ],
    "diff": [
      {
        "id": "string",
        "inputs": [],
        "revision": 0,
        "description": "string",
        "enabled": false,
        "name": "string",
        "namespace": "string",
        "output_id": "string",
        "overrides": {},
        "package": {
          "name": "string",
          "requires_root": false,
          "title": "string",
          "version": "string"
        },
        "policy_id": "string",
        "policy_ids": [
          "string"
        ],
        "errors": [
          {
            "key": "string",
            "message": "string"
          }
        ],
        "missingVars": [
          "string"
        ]
      }
    ],
    "hasErrors": false
  }
]

Generated from the API spec

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

Generated from the API spec

Path parameters

Request body { }

Responses

Request body