github
Install GitHub App
Start installing the Unkey GitHub App for your workspace. Returns a GitHub App install URL: open it in a browser to install the app and grant repository access. After installation GitHub returns to Unkey, which binds the installation to your workspace and lands you in the workspace settings.
Installation is workspace-wide and takes no parameters. Once installed, link repositories to individual apps with the git field on apps.createApp and apps.updateApp.
Required Permissions
Your root key must have the following permission:
- workspace.*.install_github
post/v2/github.installApp
Response
Install URL created. Open the returned url to install the GitHub App and finish binding it to your workspace.
Example response
{
"meta": {
"requestId": "req_123"
},
"data": {
"url": "https://github.com/apps/unkey/installations/new?state=eyJ...",
"expiresAt": 1700000900000
}
}