Dry run package policy upgrade

POST /api/fleet/package_policies/upgrade/dryrun

application/json; Elastic-Api-Version=2023-10-31

Body

packagePolicyIds array[string] Required
packageVersion string

Responses

200 application/json; Elastic-Api-Version=2023-10-31

OK
Hide response attributes Show response attributes object
- agent_diff array[array]
  
  Hide agent_diff attributes Show agent_diff attributes object
  
  data_stream object Required
  
  Additional properties are allowed.
  
  Hide data_stream attribute Show data_stream attribute object
  
  namespace string Required
  
  id string Required
  
  meta object
  
  Additional properties are allowed.
  
  Hide meta attribute Show meta attribute object
  
  package object
  
  Additional properties are allowed.
  
  Hide package attributes Show package attributes object
  
  name string Required
  
  version string Required
  
  name string Required
  
  revision number Required
  
  streams object
  
  Additional properties are allowed.
  
  Hide streams attributes Show streams attributes object
  
  data_stream object Required
  
  Additional properties are allowed.
  
  Hide data_stream attributes Show data_stream attributes object
  
  dataset string Required
  
  type string Required
  
  id string Required
  
  type string Required
  
  use_output string Required
- diff array[object]
  
  Hide diff attributes Show diff attributes object
  
  id string Required
  
  inputs array[object] Required
  
  Hide inputs attributes Show inputs attributes object
  
  config object
  
  Additional properties are allowed.
  
  enabled boolean Required
  
  processors array[string]
  
  streams array
  
  type string Required
  
  vars object
  
  Additional properties are allowed.
  
  revision number Required
  
  description string
  
  enabled boolean
  
  name string Required
  
  namespace string
  
  output_id string
  
  overrides object
  
  Additional properties are allowed.
  
  package object
  
  Additional properties are allowed.
  
  Hide package attributes Show package attributes object
  
  name string Required
  
  requires_root boolean
  
  title string
  
  version string Required
  
  policy_id string | null Deprecated
  
  policy_ids array[string]
  
  errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  key string
  
  message string
  
  missingVars array[string]
- hasErrors boolean Required
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

POST /api/fleet/package_policies/upgrade/dryrun

curl \
 -X POST https://localhost:5601/api/fleet/package_policies/upgrade/dryrun \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "packagePolicyIds": [
    "string"
  ],
  "packageVersion": "string"
}

Response examples (200)

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

Response examples (400)

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