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

List a node's reservations (platform admin)

GET
/v1/nodes/{nodeId}/reservations

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

nodeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/nodes/string/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 reservations node list <node-id>

Overview

Long-term reservations of specific GPU units on a node for a set of organizations. Reserved capacity is exclusive to its audience and hidden from everyone else.

Reserve GPU units on a node for a set of orgs (platform admin) POST

Grants exclusive placement rights over specific GPU units for a term. Reserved units disappear from every other org's catalog and cannot be placed on by them. Overlap with an existing reservation is rejected atomically.