Skip to main content

Resize a Node Pool (Cardinality)

Manually sets the number of worker nodes (cardinality) in a node pool. cardinality must be between 2 and 25. Set update_min_nodes: true to also raise the pool's minimum so autoscaling does not immediately scale it back down. The request is rejected with 412 Precondition Failed if the pool is already committed or otherwise not in a resizable state.

PUT/api/v1/kubernetes/cluster-update/{node_pool_id}

Path parameters

  • node_pool_idPathintegerrequired

    The node pool service_id (from List).

    • required
    • must be a valid node pool service ID
    example12346

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Request body

application/json

object

Manually set the worker node count of the pool.

cardinalityintegerrequired

Target number of worker nodes.

example3
  • required
  • integer between 2 and 25
update_min_nodesboolean

When true, also raise the pool's minimum to the new cardinality so autoscaling does not scale it back down.

examplefalse
  • optional
  • defaults to false

Responses

200Successful response
object

A resize on a committed pool is rejected with 412 Precondition Failed.

codeinteger
example200
dataobject
errorsobject
messagestring
exampleNode pool resize initiated