/api/2.0/fo/scan/summary/?action=list
[GET] [POST]
This is the original VM Scan Summary API for identifying hosts that were not scanned and why. We recommend you try the new improved VM Scan Summary API which has more filter options and enhanced output content. See VM Scan Summary.
Permissions - Manager role is required.
How it works - First we’ll find all the scans launched since the date (or within the date range) that you specify. Then we’ll identify hosts that were included in the scan target but not scanned for some reason. For each host you’ll see the category/reason it was not scanned and the host’s tracking method.
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. |
scan_date_since={value} |
(Required) Include scans started since a certain date. Specify the date in YYYY-MM-DD format. The date must be less than or equal to today’s date. |
scan_date_to={value} |
(Optional) Include scans started up to a certain date. Specify the date in YYYY-MM-DD format. The date must be more than or equal to scan_date_since, and less than or equal to today’s date. |
output_format={value} |
(Optional) The output format: XML (the default), CSV or JSON. |
tracking_method={value} |
(Optional) By default hosts with any tracking method will be returned in the output. Use this option to only include hosts with a certain tracking method. Valid values are: IP, DNS, NETBIOS. |
include_dead={0|1} |
(Optional) Set to 0 if you do not want to include dead hosts in the output. Dead hosts are included by default. |
include_excluded={0|1} |
(Optional) Set to 1 to include hosts that were excluded from a scan in the output. Excluded hosts are not included by default. |
include_unresolved={0|1} |
(Optional) Set to 1 to include unresolved hosts in the output. Unresolved hosts are not included by default. |
include_cancelled={0|1} |
(Optional) Set to 1 to include cancelled hosts in the output. Cancelled hosts are not included by default. |
include_notvuln={0|1} |
(Optional) Set to 1 to include hosts that are not vulnerable in the output. Not vulnerable hosts are not included by default. |
include_blocked={0|1 |
(Optional) Set to 1 to include blocked hosts in the output. Blocked hosts are not included by default. |
include_duplicate={0|1} |
(Optional) Set to 1 to include duplicate hosts in the output. Duplicate hosts are not included by default. |
include_aborted={0|1} |
(Optional) Set to 1 to include aborted hosts in the output. Aborted hosts are not included by default. |
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" "https://qualysapi.qualys.com/api/2.0/fo/scan/summary/?action=list
&scan_date_since=2018-04-27&include_excluded=1&include_unresolved=1
&include_cancelled=1&include_notvuln=1&include_duplicate=1
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SCAN_SUMMARY_OUTPUT SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/scan/summary/scan_summary_output.dtd">
<SCAN_SUMMARY_OUTPUT>
<RESPONSE>
<DATETIME>2018-05-02T10:45:40Z</DATETIME>
<SCAN_SUMMARY_LIST>
<SCAN_SUMMARY>
<SCAN_REF>scan/1525251885.92469</SCAN_REF>
<SCAN_DATE>2018-05-02T09:04:34Z</SCAN_DATE>
<HOST_SUMMARY category="notvuln" tracking="IP">10.10.10.10-10.10.10.15,10.10.10.17</HOST_SUMMARY>
<HOST_SUMMARY category="notvuln" tracking="DNS">gfi-31-1.caac125.qualys.com,gfi-31-2.caac125.qualys.com</HOST_SUMMARY>
<HOST_SUMMARY category="notvuln" tracking="NETBIOS">gfi-31-3,gfi-31-4</HOST_SUMMARY>
<HOST_SUMMARY category="cancelled" tracking="IP">10.10.10.20,10.10.10.22</HOST_SUMMARY>
<HOST_SUMMARY category="cancelled" tracking="DNS">gfi-31-5.caac125.qualys.com,gfi-31-6.caac125.qualys.com</HOST_SUMMARY>
<HOST_SUMMARY category="dead" tracking="IP">10.10.10.25</HOST_SUMMARY>
<HOST_SUMMARY category="dead" tracking="NETBIOS">gfi-31-10,gfi-31-11</HOST_SUMMARY>
<HOST_SUMMARY category="excluded" tracking="IP">10.10.10.26</HOST_SUMMARY>
<HOST_SUMMARY category="unresolved" tracking="NETBIOS">gfi-31-13</HOST_SUMMARY>
<HOST_SUMMARY category="duplicate" tracking="IP">10.10.10.27</HOST_SUMMARY>
<HOST_SUMMARY category="duplicate" tracking="DNS">gfi-31-14.caac125.qualys.com</HOST_SUMMARY>
</SCAN_SUMMARY>
</SCAN_SUMMARY_LIST>
</RESPONSE>
</SCAN_SUMMARY_OUTPUT>
Section tag |
Description |
Excluded |
The hosts were excluded. Hosts may be excluded on a per scan basis (by the user launching or scheduling the scan) or globally for all scans. Managers and Unit Managers have privileges to edit the global excluded hosts list for the subscription.. |
Cancelled |
Hosts were not scanned because the scan was cancelled. Scans may be cancelled by a user, by an administrator or automatically by the service as specified in scheduled scan settings. |
Dead |
The hosts were not “alive” at the time of the scan, meaning that they did not respond to probes sent by the scanning engine, and the option to Scan Dead Hosts was not enabled. |
Unresolved |
Hosts were scanned but they could not be reported because the NetBIOS or DNS hostname, whichever tracking method is specified for each host, could not be resolved. |
Duplicate |
The hosts were duplicated within a single segment/slice of the scan job. For example, two different hostnames resolving to the same IP with tracking by IP. |
Not Vulnerable |
Hosts were found to be not vulnerable during host discovery without having to run a full scan. This could happen for example if the list of QIDs to be scanned are limited to certain ports and those ports are found to be closed. |
Aborted |
The scan was abruptly discontinued. This is a rare occurrence that may be caused for various reasons. Contact Support for assistance. |
Blocked |
Hosts were blocked from scanning for some reason. |
<platform API server>/api/2.0/fo/scan/summary/scan_summary_output.dtd