Skip to main content
GET
List scans

Scans API

Trigger and manage security scans via API.

Trigger Scan

Request:
Response:

Get Scan Status

Response:

List Scans

Response:

What’s Next?

Violations API

Get violation data

Repositories API

Manage repositories

Authorizations

X-API-Key
string
header
required

API key for authentication. Generate from your organization settings.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
repositoryId
string

Filter by repository

status
enum<string>

Filter by status

Available options:
PENDING,
SCANNING,
COMPLETED,
FAILED
scanType
enum<string>

Filter by scan type

Available options:
sast,
sca,
secrets,
iac
sortBy
enum<string>
default:startedAt
Available options:
startedAt,
completedAt,
status
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

200 - application/json

Successful response

The response is of type any.