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

Delete (or drain) a runner pool

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.

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 delete <id>
DELETE
/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
status*string
Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/orgs/string/runner-pools/string'
Example Response
{  "status": "string"}

Get a runner pool (with usage) GET

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.

Resize a runner pool's RAM tier POST

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.