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

List runner jobs for a pool

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

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

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string
id*string

Query Parameters

limit?integer
offset?integer

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/runner-pools/string/jobs'
Example Response
[  {    "id": "string",    "runnerPoolId": "string",    "organizationId": "string",    "githubRepo": "string",    "runnerName": "string",    "runnerSizeLabel": "string",    "ramMb": 0,    "cpus": 0,    "nodeId": "string",    "status": "string",    "queuedAt": "string",    "provisioningAt": "string",    "runningAt": "string",    "completedAt": "string",    "failureReason": "string"  }]