Client API: GitHub

Connect the Coritan GitHub App so deployments build from private repositories on every push: start an installation, record it, list the installations and the repositories each reaches, and remove one. Paths are under /api/v1/git/github.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Client API reference.

GET /api/v1/git/github/install

Where to send the browser to install the GitHub App for the account (or organization). url works for expires_in seconds; GitHub then comes back to return_to, a path on this storefront.

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/git/github/installations

The owner's GitHub App installations by account, each with how many deployments clone through it, and the App itself.

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/git/github/installations

Record the installation the callback's ticket names: 201 when it is new, 200 when it refreshed one the owner already had. A ticket another account or member started answers 403, a used one 409, and an installation another owner holds 409 installation_taken.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

DELETE /api/v1/git/github/installations/{installation_ref}

Forget an installation. The deployments that cloned through it (detached) keep their repository address and build as a pasted repository would. The App stays installed on GitHub until its account uninstalls it there (manage_url).

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/git/github/installations/{installation_ref}/repositories

One page of the repositories the installation reaches, for the repository picker. A suspended installation answers 409.

Authentication: an access token, sent as Authorization: Bearer <token>.