Runners

Get the GitHub connect URL

Changed on

Returns the URL that starts a GitHub connection: the OAuth authorize URL when OAuth is configured, otherwise the GitHub App install URL. installUrl carries the App install URL (empty when no App is configured), for installing the App on another GitHub organization.

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

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

Request

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

Path parameters

orgIdstring required

Response

OK

installUrlstring required

The GitHub App install URL, for installing the App on another GitHub organization.

oauthboolean required

true when url is the OAuth authorize flow.

urlstring required

Where "Connect" sends the user: the GitHub OAuth authorize URL when oauth is true, else the GitHub App install URL.

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