Skip to main content
POST
Start a scan

Authorizations

Authorization
string
header
required

An ility API key, such as ilk_1a2b3c4d_…. Workspace owners create keys under Settings → API keys.

Path Parameters

slug
string
required
Minimum string length: 1

Body

application/json
engine_ids
string<uuid>[]
Minimum array length: 1
wcag_level
enum<string>
Available options:
2.0-A,
2.0-AA,
2.0-AAA,
2.1-A,
2.1-AA,
2.1-AAA,
2.2-A,
2.2-AA,
2.2-AAA
scope
enum<string>
Available options:
all,
unscanned

Response

Created

id
string<uuid>
required
workspace_id
string<uuid>
required
domain_id
string<uuid>
required
engine_id
string<uuid>
required
engine_slug
string
required
scan_request_id
string<uuid>
required
scope
string
required
status
string
required
trigger_source
string
required
triggered_by_user_id
string | null
required
config_snapshot
object
required
pages_scanned
integer | null
required
pages_failed
integer | null
required
issues_found
integer | null
required
score
integer | null
required
has_blocking
boolean
required
error
string | null
required
cancel_requested_at
string<date-time> | null
required
pause_requested_at
string<date-time> | null
required
paused_at
string<date-time> | null
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required