Provider

Set a node's lifecycle status

Changed on

Sets the lifecycle status of a node your organization owns to one of online, draining, maintenance, or removed, and returns the node as updated. draining and removed also terminate the VMs and pods on the node that are not already stopped; removed ends stopped pods too. A removed node answers 400 NODE_DECOMMISSIONED; re-enroll it to bring it back.

Requires the provider.write permission. See Permissions for the roles and API key permissions that include it.

patch/v1/orgs/{orgId}/provider/nodes/{nodeId}

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/provider/nodes/{nodeId}
  • Auth
    HTTP bearer

Path parameters

orgIdstring required
nodeIdstring required

Request body

status'online' | 'draining' | 'maintenance' | 'removed' required

Operator-set lifecycle state. draining and maintenance stop new placement; draining also terminates the node's workloads, while maintenance leaves them running. removed decommissions the node (its workloads and GPU units are freed); online clears an operator hold, and the next reconcile may set it back to offline if Nomad reports it down.

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, which is the product this node serves: qemu (VFIO VM host), runc (GPU-container Pod node) or process (an interruptible container). Empty reads as qemu. The runtime is detected on the box at enroll (bare metal becomes qemu, a virtualised guest becomes runc) and is never chosen on the provisioning token, so read it here after install to confirm the detection; see https://docs.openrelay.inc/docs/providers.

statusstring required
tdxEnabledboolean required
terminateAtstring nullable

When the node is removed: on an interruptible node, set by a termination notice or offboard; on a persistent node, set by a decommission with notice, until which its rentals keep running and it takes no new ones. null when none is scheduled.

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status