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

Amend a reservation's term, audience, or topology pin (platform admin)

PATCH
/v1/nodes/{nodeId}/reservations/{id}
AuthorizationBearer <token>

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

In: header

Path Parameters

nodeId*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/nodes/string/reservations/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl reservations node update <node-id> <id>