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

Resize a runner pool's RAM tier

Changes a runner pool's RAM tier (poolRamGb) and moves its subscription to the matching price. It cannot go below the RAM its active and queued jobs use.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl runners pool resize <id> --pool-ram-gb <pool-ram-gb>
POST
/v1/orgs/{orgId}/runner-pools/{id}/resize

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string
id*string

Request Body

application/json
  1. body
poolRamGb*integer

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
Example Request
curl -X POST 'https://api.openrelay.inc/v1/orgs/string/runner-pools/string/resize' \  -H 'Content-Type: application/json' \  -d '{  "poolRamGb": 0}'
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"}

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.

List runner jobs for a pool GET

Returns a runner pool's jobs, most recently queued first, with repository, runner size, status and timestamps. Pages with limit (default 50) and offset.