Skip to main content
POST

Body

application/json
​
repo
string
required

Repository identifier (format varies by service)

Example:

"owner/repository"

​
commit_id
string
required

Git commit SHA or identifier

Example:

"abc123def456"

​
access_token
string
required

Authentication token for the service

Example:

"ghp_xxxxxxxxxxxx"

​
service
enum<string>
required

Version control service provider

Available options:
github,
azuredevops,
gitlab,
bitbucket
Example:

"github"

​
branch
string

Git branch name

Example:

"main"

​
include_files
string

Comma-separated file patterns to include in analysis

Example:

"src/**/*.py,lib/**/*.js,app/**/*.ts"

​
exclude_files
string

Comma-separated file patterns to exclude from analysis

Example:

"tests/**,node_modules/**,dist/**"

​
scan_types
enum<string>[]

Subset of scanners to run. Omit (or send an empty list) to run the full analysis. Scanners left out report status: done with empty results for that commit.

Available options:
sast,
sca,
secrets,
iac,
sbom,
duplicate_code,
docstring,
antipatterns,
dead_code
Example:

Response

Analysis successfully started

​
message
string

Success message