Runners

List GitHub installations you can connect

Changed on

Exchanges the OAuth code from the GitHub redirect for the GitHub App installations your account can access, each with the connectGrant createRunnerPool takes. Installations this organization already has a pool for are flagged alreadyConnected. A state that does not match this organization answers 400 OAUTH_STATE_INVALID.

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

post/v1/orgs/{orgId}/runner-pools/installations

Request

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

Path parameters

orgIdstring required

Request body

codestring required

The OAuth code from the authorize redirect.

statestring

The signed state GitHub echoes back on the redirect. The server verifies it against the organization (anti-CSRF), so it is required whenever the OAuth flow is configured: a missing, expired or mismatched state answers 400 OAUTH_STATE_INVALID; start the connect flow again.

Response

OK

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