Skip to main content

Change Committed Settings

Changes the renewal behaviour of a committed load balancer node. Use node_status to switch between hourly billing, auto-renewal, and auto-termination at the end of the committed term. When node_status is auto_renew, committed_plan selects the term to renew into.

POST/api/v1/update_committed_node_status/

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 load balancer.

    • must be a non-empty string
    example{{location}}

Request body

application/json

object
vcn_idinteger

Identifier of the committed node/appliance whose settings are changing.

example12345
  • must be a valid integer ID
node_statusstringrequiredhourly_billing | auto_renew | auto_terminate

New billing/renewal behaviour. hourly_billing reverts to hourly, auto_renew renews into another committed term at expiry, and auto_terminate releases the node at expiry.

examplehourly_billing
  • required
committed_planstring

Committed term to renew into. Required when node_status is auto_renew.

example
  • required when node_status is auto_renew
  • must be a valid committed SKU/term

Responses

200Successful response
object

This endpoint returns a flat status / message envelope (no data/errors).

statusinteger
example200
messagestring
exampleUpdated Successfully