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

Get a runner pool (with usage)

Returns one runner pool with its RAM tier, disk size, subscription state and live usage: the active and queued runners and the RAM they hold.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl runners pool get <id>
GET
/v1/orgs/{orgId}/runner-pools/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string
id*string

Response Body

OK

application/json
  1. response
id*string
organizationId*string
name*string
githubInstallationId*integer
Formatint64
githubOwner*string
githubOwnerType*string
poolRamGb*integer
diskSizeGb*integer
runtime?string
status*string
subscriptionStatus?string
trialEndsAt?string
currentPeriodEnd?string
createdAt*string
updatedAt*string
activeRunners*integer
usedRamMb*integer
queuedRunners*integer
queuedRamMb*integer
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/runner-pools/string'
Example Response
{  "id": "string",  "organizationId": "string",  "name": "string",  "githubInstallationId": 0,  "githubOwner": "string",  "githubOwnerType": "string",  "poolRamGb": 0,  "diskSizeGb": 0,  "runtime": "string",  "status": "string",  "subscriptionStatus": "string",  "trialEndsAt": "string",  "currentPeriodEnd": "string",  "createdAt": "string",  "updatedAt": "string",  "activeRunners": 0,  "usedRamMb": 0,  "queuedRunners": 0,  "queuedRamMb": 0}

List GitHub installations you can connect POST

Exchanges the OAuth code from the GitHub redirect for the GitHub App installations your account can access, each with the connectGrant createRunnerPool takes. Installations this organization already has a pool for are flagged alreadyConnected. A state that does not match this organization answers 400 OAUTH_STATE_INVALID.

Delete (or drain) a runner pool DELETE

Deletes a runner pool, or moves it to draining when jobs are still active or queued. The response status says which: deleted or draining. A delete cancels the pool's subscription. A draining pool keeps its subscription until you call delete again once its jobs finish.