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

One-command node onboarding installer (auth = org API key bearer, OR a pre-minted provisioning token via ?token=)

Returns a self-contained shell installer (curl | sudo bash). With a bearer org API key it mints a fresh single-use provisioning token; with ?token=vtk_… (e.g. minted from the dashboard) it self-auths and embeds that token instead. name only applies when minting (the token already carries it). Nodes always enroll as QEMU VM hosts in the community pool.

GET
/v1/provider/bootstrap
AuthorizationBearer <token>

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

In: header

Query Parameters

token?string

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

gpu?string

Truthy → run the GPU passthrough (IOMMU + vfio-pci) setup. Safe on CPU-only hosts (self-skips when no GPU is present).

name?string

Token label; mint path only

Response Body

text/x-shellscript

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/provider/bootstrap"
"string"
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}