Skip to main content

Edit a Node Pool (Autoscaling)

Updates a node pool's scaling configuration: its min_vms / cardinality / max_vms, policy_type, backing plan_id, and the elastic (elasticity_policies) and scheduled (scheduled_policies) rules. The requested cardinality must lie within [min_vms, max_vms]. Use the node pool's service_id (from List Node Pools).

PUT/api/v1/kubernetes/update-node-pool/{node_pool_id}/

Path parameters

  • node_pool_idPathintegerrequired

    The node pool service_id (from List Node Pools).

    • 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 update 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

Update a node pool's sizing and scaling policies.

min_vmsintegerrequired

Minimum number of worker nodes.

example3
  • required
  • must be <= cardinality
cardinalityintegerrequired

Desired (current) number of worker nodes.

example3
  • required
  • must be between min_vms and max_vms
max_vmsintegerrequired

Maximum number of worker nodes.

example5
  • required
  • must be >= cardinality
policy_typestringrequired

Scaling policy mode.

exampleDefault
  • required
  • max length 50 characters
  • one of: Default, Custom, Default-Scheduled, Custom-Scheduled, No-policy
plan_idintegerrequired

SKU ID of the worker plan backing the pool.

example1088
  • required
  • must be a valid worker SKU ID
elasticity_policiesarray

Elastic scaling rules (scale-up adjust 1 and scale-down adjust -1).

scheduled_policiesarray

Scheduled scaling rules. Empty when the pool uses only elastic scaling.

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleNode Pool pool-worker-1 Updated Successfully