Upgrade a package policy

Base URL: https://{kibana_url}

POST /api/fleet/package_policies/upgrade

Auth

Upgrade a package policy to a newer package version.

Required authorization

Privileges fleet-agent-policies-all and integrations-all

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

packagePolicyIds string[] · max items: 1000 required

Responses

Successful response

application/json

<array> object[] · max items: 10000

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Upgrade package policies to the latest version

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/package_policies/upgrade" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "packagePolicyIds": [
      "package-policy-id-1"
    ]
  }'

Generated from the API spec

Response

Results of the upgrade operation

[
  {
    "id": "package-policy-id-1",
    "name": "nginx-1",
    "success": true
  }
]

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

Required authorization

Header parameters

Request body { }

Responses

Request body