Skip to main content
POST
/
api
/
scans
Create Scan
curl --request POST \
  --url https://api.example.com/api/scans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scan_type": "<string>",
  "dataset_dir": "<string>",
  "params": {}
}
'
{
  "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

Cookies

antidote_session
string | null

Body

application/json
scan_type
string
required
dataset_dir
string
required
params
Params · object

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