Sign in
Kubernetes

Start a version upgrade

Start an in-place Kubernetes upgrade to one of the versions from List available version upgrades. The upgrade is rolling: control-plane nodes one at a time, then workers drained first (PodDisruptionBudgets honoured). HA clusters upgrade with no API interruption; single-master clusters have a brief interruption and require confirm_single_master: true. Progress appears in the cluster events; upgrades are free.

post/api/v1/k8s/clusters/{cluster_id}/upgrade

Path parameters

cluster_idstring required

Cluster ID (short id, e.g. q7z7zg)

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Request body

version_idinteger required

Target from List available version upgrades

confirm_single_masterboolean

Required true on non-HA clusters

Response

Upgrade started

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Operation completed successfully"
}

Changes

Changed in 1 of the 28 revisions of this API.1