Skip to main content

Bulk Action

Applies the same action to multiple nodes at once. The body is a JSON payload with a node_ids array and a type field naming the action. Supported action types are the same as the single-node action endpoint's "simple" types - power_off, power_on, reboot, lock_vm, unlock_vm.

PUT/api/v1/nodes/action-on-multiple-nodes/

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 bulk action request

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

    Region of the target nodes

    • must be a non-empty string
    • should contain only URL-safe characters
    example{{location}}

Request body

application/json

object
node_idsarrayrequired

IDs of the nodes to apply the action to. All nodes must belong to the project identified by the project_id query parameter and must be in a state compatible with the chosen action (e.g. you cannot power_off a node that is already off).

  • required
  • at least one entry
  • each entry must be a positive integer node ID
  • no duplicate IDs
typestringrequiredpower_off | power_on | reboot…

The bulk-supported action to perform. A strict subset of the single-node action set - only the "simple" actions that take no additional fields are allowed in bulk.

examplepower_off
  • required
  • must be one of the bulk-supported action identifiers

Responses

200Successful response
object
codeinteger

HTTP status code of the bulk action result.

example200
  • integer between 100 and 599
datastring

Result data returned by the bulk action.

example
errorsobject
messagestring

Human-readable status message for the bulk action.

exampleAll selected nodes powered off successfuly.
  • non-empty string
  • maximum length 200 characters