Skip to main content
POST
Connect GitHub for CI

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Body

application/json
org
string

The organization whose wallet pays for the jobs. Omit for the wallet in scope.

account
string

GitHub organization or user login. Set this to authorize and link an existing installation. Omit it to install the app.

orgApp
boolean

Install Boat CI for orgs instead. It needs only the organization permission Self-hosted runners, not repository Administration. GitHub organizations only.

Response

The install or authorization link.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "ci.connect"
installUrl
string
required

Open it in a browser to install the app or authorize an existing installation. Valid 30 minutes.