Runners

List runner pools (with active/queued usage)

Changed on

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.

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

get/v1/orgs/{orgId}/runner-pools

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/runner-pools
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Response

OK

activeRunnersinteger required
createdAtstring required
currentPeriodEndstring
diskSizeGbinteger required
githubInstallationIdinteger required
githubOwnerstring required
githubOwnerTypestring required
idstring required
namestring required
organizationIdstring required
poolRamGbinteger required
queuedRamMbinteger required
queuedRunnersinteger required
runtimestring
statusstring required
subscriptionStatusstring
trialEndsAtstring
updatedAtstring required
usedRamMbinteger required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status