Skip to main content
GET
/
api
/
scans
List Scans
curl --request GET \
  --url https://api.example.com/api/scans \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "scan_type": "<string>",
    "dataset_dir": "<string>",
    "params": {},
    "status": "<string>",
    "progress": 123,
    "message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "dataset_id": "<string>",
    "dataset_name": "<string>",
    "engine_params": {},
    "started_at": "<string>",
    "finished_at": "<string>",
    "duration_seconds": 123,
    "total_issues": 0,
    "critical_count": 0,
    "high_count": 0,
    "medium_count": 0,
    "low_count": 0
  }
]

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-API-Key
string | null

Query Parameters

​
limit
integer
default:100
Required range: 1 <= x <= 10000
​
offset
integer
default:0
Required range: x >= 0
​
dataset_id
string | null

Filter scans to a specific dataset public id.

​
include_issue_counts
boolean
default:true

Include per-scan issue severity breakdowns. Disabling is faster.

Cookies

​
antidote_session
string | null

Response

Successful Response

​
id
string
required
​
scan_type
string
required
​
dataset_dir
string
required
​
params
Params · object
required
​
status
string
required
​
progress
integer
required
​
message
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
dataset_id
string | null
​
dataset_name
string | null
​
engine_params
Engine Params · object
​
started_at
string | null
​
finished_at
string | null
​
duration_seconds
number | null
​
total_issues
integer
default:0
​
critical_count
integer
default:0
​
high_count
integer
default:0
​
medium_count
integer
default:0
​
low_count
integer
default:0