GitHub
Install the Teral GitHub App for a workspace.
Install the GitHub App
POST /v1/github.installApp
Returns a link that installs the Teral GitHub App for the workspace. Open it in a browser and choose which repositories Teral may use. Afterwards GitHub sends you back to the workspace settings.
Permissions: the key needs workspace.*.install_github.
curl -X POST https://api.teral.dev/v1/github.installApp \
-H "Authorization: Bearer $TERAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Response
On success the status is 200 OK. The fields in data:
| Field | Type | Description |
|---|---|---|
url | string | The installation link. Open it in a browser. |
expiresAt | integer | When the link stops working, in Unix milliseconds. |
Error statuses: 400, 401, 403, 429, 500. See Errors for the codes behind them.