Update a Kubernetes cluster

put

https://api.linode.com/{apiVersion}/lke/clusters/{clusterId}

Updates a Kubernetes cluster.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

Identity and access permissions. Your user needs a role with these permissions. Learn more.
- Roles: lkecluster_admin
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: lke:read_write

CLI

linode-cli lke cluster-update 12345 \
  --label lkecluster54321 \
  --control_plane.high_availability true \
  --k8s_version 1.33 \
  --tags ecomm \
  --tags blog \
  --tags prod \
  --tags monitoring

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

clusterId

integer

required

ID of the Kubernetes cluster to look up.

Body Params

The fields to update the Kubernetes cluster.

control_plane

object

Defines settings for the Kubernetes control plane, including High Availability (HA) and an IP-based Access Control List (ACL) for the control plane components.

When upgrading pre-existing LKE clusters to use the HA Control Plane, the following changes will additionally occur:

All nodes will be deleted and new nodes will be created to replace them.
Any local storage (such as hostPath volumes) will be erased.
The upgrade process may take several minutes to complete, as nodes will be replaced on a rolling basis.

When upgrading pre-existing LKE clusters to use the control plane ACL for the first time, it may take several hours for external clients to respect the access control settings. This is partly due to delays from DNS propagation.

k8s_version

string

The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>. New and recycled Nodes in this cluster will be installed with the latest available patch for the Cluster's Kubernetes version.

When upgrading the Kubernetes version, only the next latest minor version following the current version can be deployed. For example, a cluster with Kubernetes version 1.29 can be upgraded to version 1.30, but not directly to 1.31.

The Kubernetes version of a cluster can not be downgraded.

label

string

length between 1 and 32

Filterable This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:

UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character か is 3 bytes in UTF-8 (0xE382AB). Its Unicode code point is 2 bytes (0x30AB). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point ("\u30ab").
4 byte UTF-8 characters are not supported.
If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.

200Returns a single Kubernetes cluster.