Sign in
LKS

Update an LKS cluster

Renames a cluster, edits its description, or upgrades the control plane. At least one of name, description or kubernetes_version must be provided.

Setting a newer kubernetes_version consents to a control-plane upgrade; the value must be a patch listed by GET /lks/available_versions with available_for_upgrade: true and must not be lower than the current one. Node pools are upgraded separately and must never run a patch newer than the control plane.

The cluster must be idle: a cluster that is provisioning, updating, scaling, upgrading, paused or deleting rejects the request with 409.

patch/lks/clusters/{id}

Path parameters

idstring required

The cluster ID (format: lksc_<hash>).

Request body

Example request

{
  "data": {
    "attributes": {
      "kubernetes_version": "1.37.2"
    }
  }
}

Response

OK

Changes

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