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

Submit a provider application

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.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl provider apply --note <note>
POST
/v1/orgs/{orgId}/provider/apply

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Request Body

application/json
  1. body
note*string

Response Body

Submitted

Example Request
curl -X POST 'https://api.openrelay.inc/v1/orgs/string/provider/apply' \  -H 'Content-Type: application/json' \  -d '{  "note": "string"}'
Example Response
Empty

Get provider and application status GET

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

List provisioning tokens (provider only) GET

Returns the organization's provisioning tokens, newest first, with each token's prefix, class, status, expiry and enrollment count. The secret is never shown. A token that can still enroll is always listed. Expired, exhausted and revoked tokens stay listed until 6 days after they expire, then fall out.