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

Get the nested VM host installer

Returns the installer that enrolls a virtual machine with nested virtualization as a VM host, an option OpenRelay turns on per provider organization. The machine enrolls as a qemu VM host and rents VMs from inside it. The route is off for every provider unless OpenRelay has turned the nested VM host option on for the organization; without it the route answers 403 NESTED_VM_NOT_ENABLED. With a bearer org API key it mints a fresh provisioning token (24 hours, any number of nodes); with ?token=otk_… it self-auths and embeds that token instead. name only applies when minting. Before it changes anything, the installer checks that the machine is a guest with /dev/kvm and a CPU that exposes hardware virtualization and, when it has GPUs, that every GPU is NVIDIA and sits behind a virtual IOMMU with interrupt remapping. It refuses a machine that fails a check and names the fix. A machine that passes enrolls as a qemu VM host with its GPUs on VFIO passthrough. A rental on such a host is a community or spot VM, or a CPU VM; a verified VM never runs on one.

Required permission

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/nested-vm

Authorization

apiKey
headerAuthorizationBearer <token>

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

Query Parameters

token?string

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

name?string

Token label; mint path only

Response Body

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

response?stringtext/x-shellscript
Example Request
curl -X GET 'https://api.openrelay.inc/v1/provider/bootstrap/nested-vm'
Example Response
"string"