Provider

List provider nodes with GPUs and location

Changed on

Returns the organization's nodes, newest first, with hardware, GPUs, location and status. Removed nodes are left out unless includeRemoved is set. A status filter returns only the nodes in that status, removed included. Each node also carries its disk space while its tunnel is up, and a summary of any live reservation on it.

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

get/v1/orgs/{orgId}/provider/nodes

Request

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

Path parameters

orgIdstring required

Query parameters

includeRemovedboolean
statusstring

Filter to one status (online|offline|maintenance|draining|removed)

class'persistent' | 'interruptible'

Node class. persistent: a provider host we schedule VMs or pods on (the default). interruptible: a provider-owned GPU container that can be reclaimed at any time, onboarded with the interruptible bootstrap.

Filter to one node class

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

  • 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