Skip to content

Generate a connection URL to GitHub App.

GET
/v1/apps/{org_uuid}/github/connection

Visiting this endpoint will attempt to initiate a connection between the organization of the authenticated user and a github.
The user needs to be an admin of the org. If the Organization is already connected, it will error.

Authorizations

jwtToken
TypeHTTP (bearer)

Parameters

Path Parameters

org_uuid*

UUID of the organization

Typestring
Required
format"uuid"

Responses

OK

application/json
JSON
{
"install_url": "https://github.com/apps/terramate-cloud/installations/new?state=secret"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI