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

Get provider and application status

Returns whether the organization is an approved provider, plus the status and submission time of its provider application when it has one.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl provider status get
GET
/v1/orgs/{orgId}/provider/status

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Response Body

OK

application/json
  1. response
isProvider*boolean
applicationStatus?string
applicationSubmittedAt?string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/provider/status'
Example Response
{  "isProvider": true,  "applicationStatus": "string",  "applicationSubmittedAt": "string"}

Get the interruptible container installer GET

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).

Submit a provider application POST

Submits the organization's application to become a provider, with a required note. Answers 400 if it is already a provider or has an application pending.