Provider

Generate a provisioning token (provider only)

Changed on

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.

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

post/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

Request body

class'persistent' | 'interruptible'

Node class. persistent: a provider host we schedule VMs or pods on (the default). interruptible: a provider-owned GPU container that can be reclaimed at any time, onboarded with the interruptible bootstrap.

maxEnrollmentsinteger

Interruptible only: the most nodes the token may enroll. Default 64.

namestring
noticeSecondsinteger

Interruptible only: the reclaim notice your market gives, in seconds. Default 30; 0 means none.

Response

Created

expiresAtstring required

24 hours after creation for a persistent token, 30 days for an interruptible one.

idstring required
maxEnrollmentsinteger

Interruptible tokens only.

namestring nullable
nodePoolstring
nodeTypestring

Node class the token enrolls: persistent | interruptible.

noticeSecondsinteger

Interruptible tokens only.

tokenstring required
tokenPrefixstring required
warningstring 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

    • 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

    • 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