GitHub and change sets
Installing the App, connecting repositories, and reading commits, change sets, dependencies and pull requests.
| Method | Path | Needs | Returns |
|---|---|---|---|
| POST | /github/install-links | repository.connect | 201 { url, expiresAt }, single-use for fifteen minutes |
| GET | /github/callback?installation_id=&state= | public | binds the installation to your organization |
| GET | /github/installations | repository.read | installations linked to the organization |
| GET | /github/installations/:id/repositories | repository.read | repositories with connectedSiteId |
| POST | /github/webhooks | public, signed | 202; verified, deduplicated, minimized, queued |
| POST | /sites/:siteId/repositories | repository.connect | 201; one repository per site; queues the inventory |
| GET | /sites/:siteId/repositories | repository.read | repositories with sourceState and pending change sets |
| DELETE | /repositories/:id | repository.connect | 204; stops monitoring, keeps history |
| GET | /repositories/:id/commits | repository.read | paginated |
| GET | /repositories/:id/change-sets | repository.read | paginated |
| GET | /repositories/:id/dependencies | repository.read | exact resolved versions from lockfiles |
| GET | /repositories/:id/pull-requests | repository.read | change sets opened by a pull request, with its verdict |
| GET | /change-sets/:id | repository.read | status, result, changeRisk { score, band }, classification |
| GET | /change-sets/:id/files | repository.read | the diff, paged |
| POST | /change-sets/:id/analyze | scan.start | analyze a pending change set now |
| GET | /sites/:siteId/code-improve | repository.read | the code-improve reading for the site |
Something here wrong, missing or out of date? Tell us and we will fix the page.