Skip to navigation
API ReferenceScans

List scans

Returns scans owned by the authenticated account in descending creation order.

Authentication

X-API-Keystring

API key in the mak.<lookup-id>.<secret> format.

Query parameters

limitintegerOptional>=1Defaults to 50

Maximum results to return. Values above 200 are capped at 200; omission uses 50.

cursorstringOptional

Opaque cursor returned as next_cursor by a previous request.

verdictstringOptional

Case-sensitive PostgreSQL LIKE fragment matched against the stored verdict; % and _ act as wildcards.

scan_idstringOptional

Case-insensitive fragment matched against the scan identifier.

source_typeenumOptional
Return direct API scans or scans submitted by an S3 integration.
Allowed values:
storage_integration_idstringOptionalformat: "uuid"
Return scans submitted by this S3 integration.
failureenumOptional

Return scans by failure presence or customer-facing failure code.

Allowed values:
filenamestringOptional

Case-sensitive PostgreSQL LIKE fragment matched against the stored filename; % and _ act as wildcards.

engine_signaturestringOptional

Case-sensitive PostgreSQL LIKE fragment matched against the stored engine signature; % and _ act as wildcards.

detection_rulestringOptional

Case-sensitive PostgreSQL LIKE fragment matched against stored detection rules; % and _ act as wildcards.

Response

A page of scans.
itemslist of objects
Scan records. Empty when the account has no scans.
next_cursorstring or null

Opaque cursor for the next page, or null when no next page exists.

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error