github
Open an operation to see its authentication, its parameters and the fields of its request and response.
9 operations
GET/v1/github
The GitHub App for this organization: status, installations, the user’s link.
/v1/githubAuthentication: Dashboard session
Response 200
| Name | Type | Description |
|---|---|---|
apprequired | object | |
app.configuredrequired | boolean | |
app.slugrequired | string | |
app.html_urlrequired | string | |
userrequired | object | |
user.linkedrequired | boolean | |
user.loginrequired | string | |
installationsrequired | array of object | |
installations[].idrequired | string | |
installations[].installation_idrequired | integer | |
installations[].account_loginrequired | string | |
installations[].account_typerequired | string | |
installations[].account_idrequired | integer | |
installations[].repository_selectionrequired | enum | Values all | selected |
installations[].permissionsrequired | object | |
installations[].eventsrequired | array of string | |
installations[].suspended_atrequired | string (date-time) | |
installations[].deleted_atrequired | string (date-time) | |
installations[].created_atrequired | string (date-time) | |
installations[].missing_permissionsrequired | array of string | |
installations[].missing_eventsrequired | array of string | |
installations[].connected_repositoriesrequired | integer | |
installations[].settings_urlrequired | string |
POST/v1/github/install
Install URL of the App with a single-use state bound to the organization.
/v1/github/installAuthentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
workspace_id | string |
Response 200
| Name | Type | Description |
|---|---|---|
urlrequired | string | |
expires_atrequired | string (date-time) |
POST/v1/github/installations
Links an installation after GitHub’s setup redirect, checked with the user’s GitHub account.
/v1/github/installationsAuthentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
installation_idrequired | integer | |
state | string | |
setup_action | enum | Values install | update | request |
Response 201
| Name | Type | Description |
|---|---|---|
installationrequired | object | |
installation.idrequired | string | |
installation.installation_idrequired | integer | |
installation.account_loginrequired | string | |
installation.account_typerequired | string | |
installation.account_idrequired | integer | |
installation.repository_selectionrequired | enum | Values all | selected |
installation.permissionsrequired | object | |
installation.eventsrequired | array of string | |
installation.suspended_atrequired | string (date-time) | |
installation.deleted_atrequired | string (date-time) | |
installation.created_atrequired | string (date-time) | |
installation.missing_permissionsrequired | array of string | |
installation.missing_eventsrequired | array of string | |
installation.connected_repositoriesrequired | integer | |
installation.settings_urlrequired | string | |
workspace_idrequired | string |
DELETE/v1/github/installations/{id}
Unlinks an installation and disconnects its repositories (the App stays on GitHub).
/v1/github/installations/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
idrequired | string | |
installation_idrequired | integer | |
account_loginrequired | string | |
account_typerequired | string | |
account_idrequired | integer | |
repository_selectionrequired | enum | Values all | selected |
permissionsrequired | object | |
eventsrequired | array of string | |
suspended_atrequired | string (date-time) | |
deleted_atrequired | string (date-time) | |
created_atrequired | string (date-time) | |
missing_permissionsrequired | array of string | |
missing_eventsrequired | array of string | |
connected_repositoriesrequired | integer | |
settings_urlrequired | string |
GET/v1/github/installations/{id}/repositories
Repositories the installation can reach, with their connection in the organization.
/v1/github/installations/{id}/repositoriesAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string | |
workspace_idqueryrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
installationrequired | object | |
installation.idrequired | string | |
installation.installation_idrequired | integer | |
installation.account_loginrequired | string | |
installation.account_typerequired | string | |
installation.account_idrequired | integer | |
installation.repository_selectionrequired | enum | Values all | selected |
installation.permissionsrequired | object | |
installation.eventsrequired | array of string | |
installation.suspended_atrequired | string (date-time) | |
installation.deleted_atrequired | string (date-time) | |
installation.created_atrequired | string (date-time) | |
installation.missing_permissionsrequired | array of string | |
installation.missing_eventsrequired | array of string | |
installation.connected_repositoriesrequired | integer | |
installation.settings_urlrequired | string | |
repositoriesrequired | array of object | |
repositories[].github_repo_idrequired | integer | |
repositories[].full_namerequired | string | |
repositories[].privaterequired | boolean | |
repositories[].archivedrequired | boolean | |
repositories[].forkrequired | boolean | |
repositories[].default_branchrequired | string | |
repositories[].html_urlrequired | string | |
repositories[].connected_repository_idrequired | string | |
repositories[].connected_workspace_idrequired | string | |
remainingrequired | integer | |
public_onlyrequired | boolean |
POST/v1/github/installations/{id}/sync
Reads the installation from GitHub again (account, permissions, suspension).
/v1/github/installations/{id}/syncAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
The same fields as DELETE /v1/github/installations/{id}.
GET/v1/github/oss/{workspaceId}
Open source settings of a workspace.
/v1/github/oss/{workspaceId}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
workspace_idrequired | string | |
auto_close_issuesrequired | boolean | |
comments_per_hourrequired | integer | |
apply_labelsrequired | boolean | |
trigger_labelrequired | "loopback" | |
exclude_labelrequired | "no-loopback" | |
public_repositoriesrequired | integer |
PATCH/v1/github/oss/{workspaceId}
Changes the open source settings of a workspace; audited.
/v1/github/oss/{workspaceId}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
auto_close_issues | boolean | |
comments_per_hour | integer | |
apply_labels | boolean |
Response 200
| Name | Type | Description |
|---|---|---|
workspace_idrequired | string | |
auto_close_issuesrequired | boolean | |
comments_per_hourrequired | integer | |
apply_labelsrequired | boolean | |
trigger_labelrequired | "loopback" | |
exclude_labelrequired | "no-loopback" | |
public_repositoriesrequired | integer |
POST/v1/webhooks/github
GitHub App webhook: X-Hub-Signature-256 over the raw body, deduplicated by delivery.
/v1/webhooks/githubVerifies the signature (the previous webhook secret too, during a rotation), stores the delivery once per X-GitHub-Delivery and queues its processing. Answers 202 within GitHub’s 10 seconds; 401 for a bad signature.
Authentication: None
Response 200
No fields.