Base URL
snake_case.
Authentication
Send an API key as a bearer token:What a key can do
A key can read everything in its workspace, and it can make the same changes a member can, such as updating an issue’s status. It acts on behalf of the owner who created it, and never with more access than that person has. Some actions need more than a key:Domains, surfaces, and slugs
In the app you work with surfaces. In the API, most routes address the website behind a surface as a domain, by itsslug, such as example-com. Get slugs from GET /v1/domains. Issues are filtered by the domain’s id.
Errors
Errors return a non-2xx status and a body with a human-readabledetail. Many also carry a machine-readable reason:
Pagination
List routes return anitems array.
- Most lists use cursors. Pass the response’s
next_cursorascursorto get the next page.next_cursorisnullon the last page. GET /v1/issuesuses page numbers: passpageandlimit(up to 100). The response’stotalcounts every matching issue.
Rate limits
Reading data isn’t rate limited. Requests that start work, such as scans, crawls, and imports, are limited per workspace per minute. When you go over, the API returns429 with a Retry-After header.
Next steps
Create an API key
Mint a key for a script or CI job.
Start a scan from CI
Trigger a scan after a deploy and wait for the result.