Sandboxes

Set which nodes may run new sandboxes. Admin only.

Changed on
put/v1/sandboxes/placement

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/sandboxes/placement
  • Auth: HTTP bearer

Request body

allowed_node_idsinteger[] nullable required

Node ids allowed to run new sandboxes; 0 is the control plane. Required: null allows every node, [] stops new sandboxes from being created anywhere. A body without this member is rejected, so an empty {} can never silently mean "every node". Existing sandboxes keep running wherever they are.

Example request

{
  "allowed_node_ids": [
    0,
    3
  ]
}

Response

Updated placement state

allowed_node_idsinteger[] nullable

Node ids allowed to run sandboxes. null = every node (the default); 0 is the control plane.

Changes