Skip to main content
GET
Get Scan Status

Get scan status

Returns status fields like status, progress_percentage, current_step, and timestamps when available.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

scan_uuid
string
required

Response

Successful Response

Detailed status information for a running or completed scan.

Attributes: uuid: Unique identifier of the scan. status: Current status (pending, running, completed, error). mode: Scan mode that was requested. progress: Human-readable progress string. progress_percentage: Numeric progress from 0 to 100. current_step: Name of the pipeline step currently executing. start_time: Timestamp when the scan was initiated. end_time: Timestamp when the scan finished (if applicable). error: Error message if the scan failed. scan_directory: Filesystem path to the scan output directory.

uuid
string
required
status
string
required
mode
string | null
progress
string | null
progress_percentage
integer | null
current_step
string | null
start_time
string<date-time> | null
end_time
string<date-time> | null
error
string | null
scan_directory
string | null