Skip to main content
GET
/
incident
/
Fetch Incidents
curl --request GET \
  --url https://example.com/api/incident/ \
  --header 'Authorization: Bearer <token>'
"<any>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
incident_type
enum<string> | null
default:secret
Available options:
secret,
vulnerability
​
repo_ids
integer[] | null

List of repository IDs

​
vc_ids
integer[] | null

List of VC IDs

​
pr_ids
integer[] | null

List of PR IDs

​
group_ids
integer[] | null

List of Group IDs

​
from_date
string<date-time> | null

Filter incidents from this date (inclusive)

​
to_date
string<date-time> | null

Filter incidents up to this date (inclusive)

​
page
integer
default:1

Page number

​
limit
integer
default:10

Number of items per page

​
sort_by
string
default:created_at

Field to sort by

​
order_by
string
default:desc

Order direction ('asc' or 'desc')

​
severity
string | null
​
status
string | null
​
type
enum<string> | null
Available options:
secret,
vulnerability
​
secret
string | null
​
search
string | null
​
pr_scan_id
integer | null
​
rule
string | null
​
commit
string | null
​
author
string | null
​
email
string | null
​
description
string | null
​
scan_type
string | null
​
whitelisted
boolean | null
​
message
string | null
​
branch
string | null
​
created_after
string<date-time> | null
​
created_before
string<date-time> | null
​
updated_after
string<date-time> | null
​
updated_before
string<date-time> | null

Response

Successful Response

The response is of type any.

⌘I