Sign in
Provider

Offboard an interruptible node, now or at a deadline (a termination notice)

Moves an interruptible node to draining at once and removes it at the deadline: terminateAt, or now plus noticeSeconds, or now when neither is given (send {}). A deadline only ever moves earlier, so repeating or replaying the call is safe. Use it to pass on a reclaim warning from the market the container runs in, or to take a node out yourself. Persistent nodes are offboarded with orl provider node update --status removed.

post/v1/orgs/{orgId}/provider/nodes/{nodeId}/offboard

Path parameters

orgIdstring required
nodeIdstring required

Request body

noticeSecondsinteger

Remove the node this many seconds from now (at most 24 h).

terminateAtstring date-time

Remove the node at this time (RFC 3339, at most 24 h ahead; a past time means now).

Response

OK

cpuCoresinteger nullable
cpuModelstring nullable
createdAtstring required
diskFreeGbinteger nullable

Free GB on the node's VM/pod data directory, from its last heartbeat. null when the node has no live tunnel: unknown, not zero free.

diskTotalGbinteger nullable

Total GB of the node's VM/pod data directory, from its last heartbeat. null when the node has no live tunnel: unknown, not zero capacity.

hostnamestring required
idstring required
locationCitystring nullable
locationCountrystring nullable
nodeTypestring required
noticeSecondsinteger nullable

Interruptible nodes only: the notice applied to a termination notice that names no deadline.

ramGbinteger nullable
runtimestring

Node runtime: qemu (VFIO VM host), runc (GPU-container Pod node) or process (an interruptible container). Empty reads as qemu.

statusstring required
tdxEnabledboolean required
terminateAtstring nullable

Interruptible nodes only: when the node is removed, set by a termination notice or offboard. null when none is scheduled.

Changes

Changed in 1 of the 40 revisions of this API.1