Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Query Parameters

page
integer
default:1

Page number of the result set. The first page is 1.

Required range: x >= 1
limit
integer
default:20

Maximum number of items per page. The default is 20 and the maximum is 100.

Required range: 1 <= x <= 100
status
enum<string>

Return only scans in this status.

Available options:
pending,
running,
completed,
failed,
cancelled
scan_type
enum<string>

Return only scans of this type. whitebox scans include source code, blackbox scans test targets externally.

Available options:
whitebox,
blackbox
date_from
string<date-time>

Filter scans created on or after this date (ISO 8601).

date_to
string<date-time>

Filter scans created on or before this date (inclusive, end-of-day).

domain_id
string<uuid>

Return only scans that target this domain UUID.

repository_id
string<uuid>

Return only the scans that include this repository.

Case-insensitive substring match on the scan title.

include_retests
boolean
default:false

Include per-finding retest scans in the results. Excluded by default, matching the dashboard pentest list.

sort_by
enum<string>
default:created_at

Field to sort by. Only created_at is supported.

Available options:
created_at
sort_order
enum<string>
default:desc

Sort direction. Use asc for oldest first or desc for newest first.

Available options:
asc,
desc

Response

Paginated list of scans.

items
object[]
required
meta
object
required
scansThisMonth
integer