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

List a node's reservations

Returns every reservation on one node, each with its reserved unit ids, the units released to spot, its audience, managing orgs, term and status. Readable by a platform operator, the org that owns the node, and any org managing a reservation on it that is active and inside its term. Anyone else gets 404.

Required permission

Requires the reservation.read permission. A caller without it gets 404. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl reservations node list <node-id>
GET
/v1/nodes/{nodeId}/reservations

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

nodeId*string

Response Body

OK

application/json
  1. response
[index: integer]?

Exclusive placement rights for a set of orgs over specific GPU units of one node, for a term. Scoped to units, not GPU counts, because units are the indivisible allocation primitive.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/nodes/string/reservations'
Example Response
[  {    "id": "string",    "nodeId": "string",    "reservedUnitIds": [      "string"    ],    "releasedUnitIds": [      "string"    ],    "allowedOrgIds": [      "string"    ],    "managingOrgIds": [      "string"    ],    "startsAt": "string",    "endsAt": "string",    "status": "pending",    "topologyGen": 0,    "contractRef": "string",    "reason": "string",    "createdAt": "string",    "updatedAt": "string",    "terminated": [      "string"    ],    "skipped": [      "string"    ],    "wouldTerminate": [      "string"    ],    "wouldSkip": [      "string"    ]  }]