Skip to main content

List the scan queue of a host scan service

GET 
/api/v1/HostScanService/scanQueue

Returns a page of the scan actions for one host scan service. By default it lists the actions assigned to that service, and the queuedFilter parameter lists the actions still waiting in the queue instead. Use it to see what the service is running or has run.

Permission required: Admin or App role, and the sign-in must satisfy the multi-factor authentication requirement.

Values for queuedFilter: 0 = All, 1 = QueuedItems, 2 = ExcludeQueuedItems.

Values for status: -4 = Paused, -3 = Scheduled, -2 = Unknown, -1 = Pending, 0 = Queued, 1 = Running, 2 = Complete, 3 = Failed, 4 = Cancelled, 5 = CompletedWithErrors, 6 = CompletedNotRun.

Request​

Responses​

A page of scan queue entries with the total number of matches. Each entry has the action name, start and end time, status, host and related IDs.