Skip to main content

Scan a repo

Trigger a scan by providing a repository URL (or ref). You can wait for the scan to finish or poll for results.

SDK

Poll for results

If you don’t use waitForCompletion, poll the scan result:

REST API

Start scan: POST /v1/security/scan Headers: Authorization: Bearer key_...
Body:
Response (started):
Response (with waitForCompletion: true):
Get result: GET /v1/security/scan/:scanId

Finding shape

CI example

Fail the build on high or critical:
Next: Security API reference.