Skip to main content
POST
Create Scan

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

Cookies

blindsight_session
string | null

Body

application/json
scan_type
string
required
dataset_dir
string
required
params
Params · object | 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 | null
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