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

Get one node reservation

Returns one reservation on a node: its reserved unit ids, the units currently released to spot, its audience, managing orgs, term and status. Readable by the same orgs as the list: a platform operator, the org that owns the node, and any org managing a reservation on it that is active and inside its term.

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 get <node-id> <id>
GET
/v1/nodes/{nodeId}/reservations/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

nodeId*string
id*string

Response Body

OK

application/json
  1. response

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.

id*string
nodeId*string
reservedUnitIds*array<string>
releasedUnitIds?array<string>

The subset of reservedUnitIds currently on the spot market (double sell). Still this reservation's capacity, sellable to anyone at tier=spot only, and reclaimable at any time.

allowedOrgIds*array<string>

The audience: orgs that may place workloads on the reserved units.

managingOrgIds?array<string>

Orgs that may release these units to the market, reclaim them, and terminate the spot workloads on them, on the node owner's behalf, while the reservation is active and inside its term. Being in the audience does not confer this.

startsAt*string
endsAt?string

Absent = open-ended until cancelled

status*string

needs-review means the node's GPU topology changed under the reservation: it grants nothing (and withholds its units from everyone) until an operator re-affirms it.

Value in"pending""active""expired""cancelled""needs-review"
topologyGen?integer

Node topology generation this reservation was written against

contractRef?string
reason?string
createdAt?string
updatedAt?string
terminated?array<string>

Reclaim only: spot VM ids terminated to free the reclaimed units.

skipped?array<string>

Reclaim only: VM ids left running because they are not spot.

wouldTerminate?array<string>

Reclaim dry run only: the spot VM ids this call would terminate.

wouldSkip?array<string>

Reclaim dry run only: VM ids that would be left running.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/nodes/string/reservations/string'
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"  ]}

Reserve GPU units for 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.

Amend a reservation (platform admin) PATCH

Changes a reservation's term end, audience, or managing orgs, or re-pins it to the node's current topology, and returns the updated reservation. Re-pinning (reaffirm) also reactivates a reservation in needs-review. The start of the term is fixed at create.