Skip to main content
GET
Poll progress / result of an async (Mode A) batch scan

Path Parameters

id
string<uuid>
required

The scan_id returned by the Mode A POST /v3/wfp/scan.

Response

Current session state (and result once completed).

Unified status envelope returned by POST /v3/wfp/scan (both modes) and GET /v3/wfp/scan/{id}. Mode B returns it synchronously already at status: completed; Mode A returns it per block (uploading) and on each poll. Zero-valued fields are omitted, so an uploading session carries no scan counters and a running scan carries no result.

scan_id
string<uuid>
required

Canonical lowercase UUIDv7 session id. In Mode A this is the client-supplied id; in Mode B it is a server-generated id for traceability only (no session is created).

Example:

"018f7b2c-9a3e-7d41-8b6a-2c1d4e5f6a7b"

status
enum<string>
required
Available options:
uploading,
queued,
scanning,
completed,
failed,
expired
received_bytes
integer

Bytes received so far (Mode A upload; omitted when 0).

total_bytes
integer

Declared total upload size (Mode A; omitted when 0).

upload_percent
integer

Exact upload progress percent (Mode A; omitted when 0).

phase
string

Current pipeline pass while scanning, e.g. 'Pass 1: scan files'.

phase_done
integer

Items processed in the current phase.

phase_total
integer

Total items in the current phase.

files_total
integer

File count of the report, filled in on completion.

result
object

Populated only when status is completed. The batchScanner report — byte-identical whether obtained synchronously (Mode B) or by polling an async session to completion (Mode A).

error
string

Populated only when status is failed.