Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
CLICommands

orl provider node offboard

Offboard an interruptible node (asks for confirmation; --yes to skip), part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing.

orl provider node offboard <node-id>

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.

Flags

FlagTypeRequired
--notice-secondsintnoRemove the node this many seconds from now (at most 24 h for an interruptible node).
--terminate-atstringnoRemove the node at this time (RFC 3339; for an interruptible node at most 24 h ahead, and a past time means now).
--bodystringnoa JSON object of request body fields, merged under any of this command's own flags that are also set, e.g. {"key":"value"}
--body-filestringnoread the --body JSON object from a file (- for stdin)
--yesboolnoskip the confirmation prompt
--forceboolnoalias for --yes

This wraps the offboardProviderNode API operation.

On this page