Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Sources

Retrieve a scan's live progress

⚠️ Beta endpoint: behavior and schemas are subject to change.

Retrieve the live progress of a historical scan: a coarse status (queued, in_progress, completed) plus, while the scan is running, element/byte counters read straight from the scan's in-memory progress tracking.

Poll this endpoint instead of the scan detail endpoint while a scan is running. Once the scan reaches completed, the response includes an audit_url pointing at the scan's audit summary; stop polling and fetch that endpoint instead.

elements_total is provisional while listing_finished is false — it only reflects elements listed so far, not the final total.

get/v1/scans/{scan_id}/live-progress

Path parameters

scan_idstring uuid required

The id of the scan to retrieve the live progress of.

Response

Scan live progress

status'queued' | 'in_progress' | 'completed' required

Coarse live-progress phase of the scan.

audit_urlstring nullable

URL of the scan's audit summary. Only present once status is completed.

elements_scannedinteger nullable

Number of elements scanned so far. Absent when status is completed.

elements_totalinteger nullable

Number of elements listed so far. Provisional (still growing) until listing_finished is true. Absent when status is completed.

listing_finishedboolean nullable

Whether the scan has finished listing all its elements, i.e. whether elements_total reflects the true final count. Absent when status is completed.

elements_skippedinteger nullable

Number of elements skipped so far. Absent when status is completed.

elements_failedinteger nullable

Number of elements that failed to scan so far. Absent when status is completed.

data_downloaded_bytesinteger nullable

Amount of data downloaded so far, in bytes. Absent when status is completed.

data_scanned_bytesinteger nullable

Amount of data scanned so far, in bytes. Absent when status is completed.

Example response

{
  "status": "in_progress",
  "audit_url": "/v1/scans/3fa85f64-5717-4562-b3fc-2c963f66afa6/audit",
  "elements_scanned": 128,
  "elements_total": 512,
  "elements_skipped": 3,
  "data_downloaded_bytes": 10485760,
  "data_scanned_bytes": 10485760
}