Skip to content
Coritan Docs

Organization API: Organization GitHub

The organization's GitHub App installations, as /api/v1/git/github serves an account's, so its deployments build from its repositories on every push.

View as Markdown

The organization's GitHub App installations, as /api/v1/git/github serves an account's, so its deployments build from its repositories on every push.

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

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

Method Path Summary
GET /api/v1/orgs/{org_slug}/git/github/install Start a GitHub App install
GET /api/v1/orgs/{org_slug}/git/github/installations List installations
POST /api/v1/orgs/{org_slug}/git/github/installations Record a GitHub installation
DELETE /api/v1/orgs/{org_slug}/git/github/installations/{installation_ref} Forget a GitHub installation
GET /api/v1/orgs/{org_slug}/git/github/installations/{installation_ref}/repositories List an installation's repositories

GET /api/v1/orgs/{org_slug}/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.

Name In Type Required Description
org_slug path string yes
return_to query string or null no A dashboard path to come back to, such as /dashboard/deployments; left out or not a path, /dashboard/order/app-deployment
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

GET /api/v1/orgs/{org_slug}/git/github/installations

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

Name In Type Required
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

POST /api/v1/orgs/{org_slug}/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.

Name In Type Required
org_slug path string yes

application/json (required)

Field Type Required
ticket string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

DELETE /api/v1/orgs/{org_slug}/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).

Name In Type Required
installation_ref path integer yes
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

List an installation's repositories

Section titled List an installation's repositories

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

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

Name In Type Required Description
installation_ref path integer yes
org_slug path string yes
page query integer no The page, from 1, in the order GitHub lists them Default: 1.
per_page query integer no Repositories on a page Default: 30.
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.