Sign in
Kubernetes

Scale a node pool

Sets the pool's node count. Scaling down drains the nodes it removes first. A cluster that is creating, deleting or failed answers 409 INVALID_CLUSTER_STATE; a failed cluster has no control plane to join. Needs clusters:write on an API key, or the owner, admin or member role on a session.

post/v1/kubernetes/clusters/{id}/node-pools/{poolId}/scale

Path parameters

idstring required
poolIdstring required

Request body

countinteger required

The pool's new node count. Delete the pool to remove every node.

expectedCountinteger

Optional count the caller reviewed. If the current count differs, answers 409 CONCURRENT_UPDATE without scaling. The comparison and write are atomic.

Response

Scaling started

clusterIdstring required
countinteger required

Nodes the pool holds once it converges.

createdAtstring required
idstring required
namestring required
readyCountinteger required

Nodes that joined the cluster and are Ready.

status'creating' | 'ready' | 'scaling' | 'deleting' | 'failed' required

Changes

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