Provider

Get the one-command node installer

Changed on

Returns a self-contained shell installer, run on the host with curl piped to sudo bash, that enrolls the machine as a provider node in the community pool. With a bearer org API key it mints a fresh provisioning token (24 hours, any number of nodes); with ?token=otk_… (e.g. minted from the dashboard) it self-auths and embeds that token instead. name only applies when minting (the token already carries it). The runtime is detected on the box, not chosen here: a bare metal host enrolls as a qemu VM host with VFIO passthrough, and a virtualised guest enrolls as a runc pod host on its native NVIDIA or AMD driver.

With an API key: checked against the provider.write permission for the resource it acts on. See Permissions for the roles and API key permissions that include it.

get/v1/provider/bootstrap

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/provider/bootstrap
  • Auth
    • HTTP bearer
    • or none

Query parameters

tokenstring

Pre-minted provisioning token (otk_…); replaces bearer auth

gpustring

Accepted for backward compatibility and ignored; it selects nothing. The installer detects the runtime on the box (systemd-detect-virt) and takes --gpu only to discard it.

namestring

Token label; mint path only

Response

The installer script (contains a secret provisioning token, never cached)

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

    • 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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status