Github App Install Url — GET /api/v1/github/app/install-url
Github App Install Url
Where to install the App for this project, with a signed, user-bound, 10-minute state. QA lead.
Endpoint: GET /api/v1/github/app/install-url
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA lead or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
project_id | query | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | GitHubAppInstallUrl (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
409, with the message “The deployment’s GitHub App is not configured. An administrator sets it in Settings › GitHub App”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: GitHub App
- Operation ID:
github_app_install_url_api_v1_github_app_install_url_get - Source code:
backend/app/routers/github_app.py, line 152 - Specification: OpenAPI JSON