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

List runner pools (with active/queued usage)

Returns the organization's GitHub runner pools, newest first, with active and queued runner counts and the RAM they hold. Deleted pools are left out.

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 list
GET
/v1/orgs/{orgId}/runner-pools

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
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/runner-pools'
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  }]

Overview

Managed GitHub Actions runner pools: connect a GitHub installation, create, resize or delete pools, and list each pool's jobs, metrics and cost comparison.

Create a runner pool POST

Connects a GitHub organization's App installation as a runner pool and starts its subscription. Repeating it returns the pool while it is active or suspended. name defaults to the GitHub owner, poolRamGb to 64 when omitted or 0, and diskSizeGb to 100 when omitted. A payment method must be on file (CARD_REQUIRED), and a personal GitHub account is refused (USER_ACCOUNT_UNSUPPORTED). When the OAuth flow is configured, pass the installation's grant from listRunnerInstallations (GRANT_REQUIRED).