Repository (Deep Scan)¶
Submit repositories for source-level deep scanning, fetch the results, and poll the scan status - the API behind the Repositories and Bulk Repositories features.
Use cases¶
- Orchestrate a deep scan from an external scheduler rather than the UI.
- Drive a CI/CD step that triggers a deep scan on every new branch.
- Poll the status of a long-running bulk scan and consume the results when ready.
Operations¶
| Method | Path | What it does | Scopes |
|---|---|---|---|
| POST | /repository/scan |
Create deep scan | See API scopes |
| GET | /repository/results |
Get deep scan results URL | See API scopes |
| GET | /repository/status |
Get deep scan status | See API scopes |
Request and response schemas are in the OpenAPI specification, which is also available as interactive documentation in the app.
Authentication¶
Send your key in the x-api-key header. The Scopes column shows which key scopes may call each operation; a key with another scope gets 403. See API scopes.