Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Runners

GitHub connect URL (OAuth authorize when configured, else App install)

GET
/v1/orgs/{orgId}/runner-pools/connect-url
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

orgId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orgs/string/runner-pools/connect-url"
{
  "url": "string",
  "installUrl": "string",
  "oauth": true
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl runners connect-url get