Skip to main content
POST
Start a scan

Authorizations

Authorization
string
header
required

API token obtained from the login endpoint or the dashboard

Query Parameters

account_id
string

Which account to act on, as the account's API id. Only meaningful for a user API key, which may reach several accounts — an account key already identifies exactly one and ignores this.

Accepted by the endpoints that declare it; others act on the account the key resolves to on its own.

Optional for reads, where it narrows the request to that account. Required for writes that declare it when the key can reach more than one account: without it the request would act on an account it picked rather than one you named, so it is refused with a 400.

Body

application/json

Scan to queue

scan
object
required

Response

Queued scan

data
object
Example: