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

Provider node + token stats

Returns counts of the organization's nodes (total, online and offline, removed nodes excluded) and of its provisioning tokens that can still enroll a node.

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 stats get
GET
/v1/orgs/{orgId}/provider/stats

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
totalNodes*integer
onlineNodes*integer
offlineNodes*integer
activeTokens*integer
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/provider/stats'
Example Response
{  "totalNodes": 0,  "onlineNodes": 0,  "offlineNodes": 0,  "activeTokens": 0}