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

Revoke a provisioning token

Revokes a provisioning token so it can no longer enroll nodes, and it stays listed as revoked. Nodes the token already enrolled keep running. A legacy API key needs clusters:write.

Required permission

Requires the provider.write permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl provider provisioning-token delete <id>
DELETE
/v1/orgs/{orgId}/provider/tokens/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string
id*string

Response Body

Revoked

Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/orgs/string/provider/tokens/string'
Example Response
Empty

Generate a provisioning token (provider only) POST

Mints a provisioning token for enrolling nodes and returns its secret, shown only once. A persistent token enrolls any number of nodes for 24 hours. An interruptible token (class interruptible) lives 30 days and enrolls at most maxEnrollments nodes. A legacy API key needs clusters:write.

List provider nodes with GPUs and location GET

Returns the organization's nodes, newest first, with hardware, GPUs, location and status. Removed nodes are left out unless includeRemoved is set. A status filter returns only the nodes in that status, removed included. Each node also carries its disk space while its tunnel is up, and a summary of any live reservation on it.