Skip to main content
POST
Trigger a scan (GitHub or GitLab)

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Safely retry a POST/PATCH; a replayed key returns the original response.

Maximum string length: 255

Body

application/json
name
string
required
Minimum string length: 1
repository
string

owner/repo, or a full GitHub or GitLab URL. Send repository or repository_ids, not both.

Minimum string length: 1
repository_ids
string<uuid>[]

Connected repository IDs to cover in one scan, up to 100. All must use the same provider. The first ID is the scan's primary repository. Send repository or repository_ids, not both. Cannot be combined with provider, commit, or base_commit.

Required array length: 1 - 100 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
provider
enum<string>
Available options:
github,
gitlab
branch
string
Minimum string length: 1
commit
string

Scan exactly this commit instead of the branch tip. Full or abbreviated SHA; it must exist in the repository.

Pattern: ^[0-9a-f]{7,40}$
base_commit
string

Analyze only the files changed from this commit to commit (a diff scan). Requires commit; findings land as repository findings.

Pattern: ^[0-9a-f]{7,40}$
model
enum<string>
Available options:
haiku,
sonnet,
opus

Response

Scan created

object
string
required
Allowed value: "scan"
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
status
string | null
required
is_done
boolean
required
progress
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
programming_language
string | null
required
kind
enum<string>
required
Available options:
main,
pr,
fix,
context
branch
string | null
required
commit_sha
string | null
required
pull_request_number
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
repository
string | null
required
model
string | null
required
vulnerability_counts
object
required
created_at
string
required
ended_at
string | null
required