Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Scans

Get Scan Statuses

Use this API to retrieve the status of the specified scans.

post/api/cmp/v1/webscans/status

Request body

string[] required

Response

OK

scanIdstring uuid

The unique identifier of the scan.

status'QUEUED' | 'PENDING' | 'INPROGRESS' | 'MIGRATION_STARTED' | 'MIGRATION_COMPLETED' | 'CATEGORIZATION_STARTED' | 'CATEGORIZATION_FAILED' | 'COMPLETED' | 'ERROR' | 'CANCELLED' | 'SCANNING' | 'DATA_MOVE' | 'RETRY_BY_AUTO_CORRECT' | 'MS_IOS_SCAN_SUCCESS' | 'MS_IOS_SCAN_FAILED' | 'MS_EXPORT_XLS_STARTED' | 'MS_EXPORT_PDF_STARTED'

The current state or condition of the item.

messagestring

The message or notification text.

Example response

[
  {
    "scanId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "status": "INPROGRESS",
    "message": "Scan status found"
  }
]