Provider

List provisioning tokens (provider only)

Changed on

Returns the organization's provisioning tokens, newest first, with each token's prefix, class, status, expiry and enrollment count. The secret is never shown. A token that can still enroll is always listed. Expired, exhausted and revoked tokens stay listed until 6 days after they expire, then fall out.

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

get/v1/orgs/{orgId}/provider/tokens

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/provider/tokens
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Response

OK

createdAtstring required
enrollmentCountinteger required

Nodes enrolled with this token so far. A persistent token is uncapped; an interruptible token stops enrolling at maxEnrollments.

expiresAtstring required

24 hours after createdAt for a persistent token, 30 days for an interruptible one. Every token expires; the lifetime is fixed per class.

idstring required
lastUsedAtstring nullable
maxEnrollmentsinteger

Interruptible tokens only: the most nodes this token may enroll.

namestring nullable
nodePoolstring
nodeTypestring required

Node class the token enrolls: persistent | interruptible.

noticeSecondsinteger

Interruptible tokens only: the reclaim notice, in seconds, applied to a termination notice that names no deadline.

revokedAtstring nullable
statusstring required

active | exhausted | expired | revoked. A token that has enrolled nodes is still active until it expires or is revoked; exhausted is an interruptible token that has used all maxEnrollments.

tokenPrefixstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status