Sign in
Nodes

Get the drain status for a node, including migration progress.

Returns container counts and whether the drain is complete. Can be polled to track drain progress.

get/internal/nodes/{node_id}/drain

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/internal/nodes/{node_id}/drain
  • Auth: HTTP bearer

Path parameters

node_idinteger required

Node ID

Response

Drain status

can_removeboolean required

Can the node be safely removed?

drain_completeboolean required

Whether the source node is empty and safe to remove. Replacement deployments may still be converging asynchronously on other nodes.

messagestring required
node_idinteger required
node_namestring required
remaining_containersinteger required

Number of containers still on this node

remaining_sandboxesinteger required

Sandboxes (any owner) still on this node. Draining does not move sandboxes; evict them before removing the node (ADR-048).

statusstring required

Changes