Runners

Get a runner pool (with usage)

Changed on

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.

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

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

Request

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

Path parameters

orgIdstring required
idstring 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

    • 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

    • 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