Skip to main content

Worker Node Power/Reboot/Rename Action

Performs a lifecycle action on a single worker node. The action is chosen with the required action query parameter: power_on, power_off, reboot, or rename. The path takes the node pool service_id and the node's id.

PUT/api/v1/kubernetes/node-pool/{node_pool_id}/update-worker-node/{node_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
  • node_idPathintegerrequired

    The id of the worker node (from Node Pool Details).

    • required
    • must be a valid worker node ID
    example320001

Query parameters

  • actionQuerystringrequired

    The lifecycle action to perform on the node.

    • required
    • one of: power_on, power_off, reboot, rename
    examplereboot
  • 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

The lifecycle action takes an empty request body; the action is set via the action query parameter.

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleAction performed successfully