/api/2.0/fo/scan/stats/?action=list
[GET] [POST]
List details about vulnerability scans and assets that are waiting to be processed.
Permissions - Manager role is required.
Parameter |
Description |
action=list |
(Required) |
echo_request={0|1} |
(Optional) Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" "https://qualysapi.qualys.com/api/2.0/fo/scan/stats/?action=list"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE TASK_PROCESSING SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/scan/stats/vm_recrypt_results.dtd">
<TASK_PROCESSING>
<UNPROCESSED_SCANS><![CDATA[366]]></UNPROCESSED_SCANS>
<VM_RECRYPT_BACKLOG><![CDATA[116]]></VM_RECRYPT_BACKLOG>
<VM_RECRYPT_BACKLOG_BY_SCAN>
<SCAN>
<ID><![CDATA[189275]]></ID>
<TITLE><![CDATA[API_V2_IP_Scan_1511513769]]></TITLE>
<STATUS><![CDATA[Loading]]></STATUS>
<PROCESSING_PRIORITY><![CDATA[None]]></PROCESSING_PRIORITY>
<COUNT><![CDATA[2]]></COUNT>
</SCAN>
<SCAN>
<ID><![CDATA[189281]]></ID>
<TITLE><![CDATA[API_V2_AG_Scan_1511513846]]></TITLE>
<STATUS><![CDATA[Loading]]></STATUS>
<PROCESSING_PRIORITY><![CDATA[None]]></PROCESSING_PRIORITY>
<COUNT><![CDATA[2]]></COUNT>
</SCAN>
<SCAN>
<ID><![CDATA[190773]]></ID>
<TITLE><![CDATA[API_V2_IP_Scan_]]></TITLE>
<STATUS><![CDATA[Finished]]></STATUS>
<PROCESSING_PRIORITY><![CDATA[None]]></PROCESSING_PRIORITY>
<COUNT><![CDATA[2]]></COUNT>
</SCAN>
<SCAN>
<ID><![CDATA[190775]]></ID>
<TITLE><![CDATA[API_V2_IP_Scan_]]></TITLE>
<STATUS><![CDATA[Finished]]></STATUS>
<PROCESSING_PRIORITY><![CDATA[None]]></PROCESSING_PRIORITY>
<COUNT><![CDATA[2]]></COUNT>
</SCAN>
...
</VM_RECRYPT_BACKLOG_BY_SCAN>
<VM_RECRYPT_BACKLOG_BY_TASK>
<SCAN>
<ID><![CDATA[210337]]></ID>
<TITLE><![CDATA[API_V2_AG_Scan_1515055579]]></TITLE>
<STATUS><![CDATA[Loading]]></STATUS>
<PROCESSING_PRIORITY><![CDATA[None]]></PROCESSING_PRIORITY>
<NBHOST><![CDATA[]]></NBHOST>
<TO_PROCESS><![CDATA[3]]></TO_PROCESS>
<PROCESSED><![CDATA[0]]></PROCESSED>
<SCAN_DATE><![CDATA[2018-01-04T08:46:13Z]]></SCAN_DATE>
<SCAN_UPDATED_DATE><![CDATA[2018-01-04T08:58:05Z]]></SCAN_UPDATED_DATE>
<TASK_TYPE><![CDATA[VM Scan Processing]]></TASK_TYPE>
<TASK_STATUS><![CDATA[Queued]]></TASK_STATUS>
<TASK_UPDATED_DATE><![CDATA[2018-01-12T08:17:09Z]]></TASK_UPDATED_DATE>
</SCAN>
...
Section tag |
Description |
UNPROCESSED SCANS |
The total number of scans that are not processed, including scans that are queued, running, loading, finished, etc. |
VM RECRYPT BACKLOG |
The total number of assets across your finished scans that are waiting to be processed. |
VM RECRYPT BACKLOG BY SCAN |
Scan details for vulnerability scans that are waiting to be processed. For each scan, you’ll see the scan ID, scan title, scan status, processing priority and number of hosts that the scan finished but not processed. |
VM RECRYPT BACKLOG BY TASK |
Processing task details for vulnerability scans that are waiting to be processed. For each task, you’ll see the same scan details as VM RECRYPT BACKLOG BY SCAN plus additional information like the total hosts alive for the scan, the number of hosts from the scan that have been processed, the number of hosts waiting to be processed, the scan start date, the task type and task status. |
<platform API server>/api/2.0/fo/scan/stats/vm_recrypt_results.dtd