Runners

Create a runner pool

Changed on

Connects a GitHub organization's App installation as a runner pool and starts its subscription. Repeating it returns the pool while it is active or suspended. name defaults to the GitHub owner, poolRamGb to 64 when omitted or 0, and diskSizeGb to 100 when omitted. A payment method must be on file (CARD_REQUIRED), and a personal GitHub account is refused (USER_ACCOUNT_UNSUPPORTED). When the OAuth flow is configured, pass the installation's grant from listRunnerInstallations (GRANT_REQUIRED).

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

post/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

Request body

diskSizeGbinteger
githubOwnerstring
githubOwnerTypestring
grantstring

The connectGrant of the chosen installation from listRunnerInstallations. Required when the OAuth flow is configured (getRunnerConnectUrl answers oauth: true).

installationIdinteger required
namestring
poolRamGbinteger

Response

Created

createdAtstring required
currentPeriodEndstring
diskSizeGbinteger required
githubInstallationIdinteger required
githubOwnerstring required
githubOwnerTypestring required
idstring required
namestring required
organizationIdstring required
poolRamGbinteger required
runtimestring
statusstring required
subscriptionStatusstring
trialEndsAtstring
updatedAtstring 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

    • 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

    • 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