Skip to main content

Change Committed Node Settings

Updates the committed (reserved) billing settings of a node pool's nodes. Set node_status to auto_renew to auto-renew the commitment on expiry, or to hourly_billing to fall back to hourly billing when the term ends. committed_plan is the committed-plan option (sku_day_id) to switch to.

PUT/api/v1/kubernetes/change-committed-settings/{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 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 the committed billing settings of the pool's nodes.

node_statusstringrequired

Committed billing behaviour on term expiry.

examplehourly_billing
  • required
  • one of: auto_renew, hourly_billing
committed_planinteger

Committed-plan option (sku_day_id) to switch to. Use 0 to leave the plan unchanged.

example0
  • optional

Responses

200Successful response
object
codeinteger
example200
dataarray
errorsobject
messagestring
exampleKubernetes Committed Nodes Plans are updated