Skip to main content

Update Committed Settings

POST/api/v1/update_committed_node_status/

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the request.

    • required
    • must be a valid API key string
    example{{api_key}}
  • locationQuerystringoptional

    Location identifier for the settings update

    • non-empty string
    • URL-encoded if containing special characters
    example{{location}}

Request body

application/json

string

JSON-formatted string with the payload to update committed settings

example{ "vcn_id": {{node_id}}, // "node_status": "auto_renew", "node_status": "hourly_billing", // "node_status": "auto_terminate", "committed_plan": 318 }
  • must be a valid JSON string
  • must include "vcn_id" and "committed_plan" fields
  • "node_status" if present must be one of "auto_renew", "hourly_billing", or "auto_terminate"

Responses

200Successful response
object
statusinteger

HTTP status code of the update operation

example200
  • integer value
  • must be a valid three-digit HTTP status code
messagestring

Status message indicating the result of the update operation

exampleUpdated Successfully
  • must be a non-empty string
  • max length 255 characters