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

Get the interruptible container installer

Returns a POSIX sh installer that enrolls the container it runs in as an interruptible node. It needs no root, systemd or capabilities to run. Run it inside the container as `curl -fsSL "<url>" | sh` or `wget -qO- "<url>" | sh`. It downloads the interruptible agent for the container's architecture, verifies its sha256, and runs it; the agent enrolls the container and detaches. The token must be an interruptible one (orl provider provisioning-token create --class interruptible).

Required permission

Requires no permission: the credential the request carries authorizes it.

GET
/v1/provider/interruptible/bootstrap

Query Parameters

token*string

Interruptible provisioning token (otk_...)

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/interruptible/bootstrap?token=string'
Example Response
"string"