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

List the provider org's nodes (with GPUs + location)

GET
/v1/orgs/{orgId}/provider/nodes
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

orgId*string

Query Parameters

includeRemoved?boolean
status?string

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orgs/string/provider/nodes"
[
  {
    "id": "string",
    "hostname": "string",
    "nodeType": "string",
    "tdxEnabled": true,
    "status": "string",
    "cpuModel": "string",
    "cpuCores": 0,
    "ramGb": 0,
    "createdAt": "string",
    "locationCity": "string",
    "locationCountry": "string",
    "gpus": [
      {
        "gpuName": "string",
        "vramGb": 0,
        "quantity": 0
      }
    ],
    "reservation": {
      "reservedUnitCount": 0,
      "releasedUnitCount": 0,
      "reservations": [
        {
          "id": "string",
          "nodeId": "string",
          "reservedUnitIds": [
            "string"
          ],
          "allowedOrgIds": [
            "string"
          ],
          "startsAt": "string",
          "endsAt": "string",
          "status": "pending",
          "topologyGen": 0,
          "contractRef": "string",
          "reason": "string",
          "createdAt": "string",
          "updatedAt": "string"
        }
      ]
    }
  }
]
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl provider node list