Appendix C- Scan Results JSON

This section describes all the possible keys involved when a Scan API “fetch” request is made in JSON format (/api/2.0/fo/scan/?action-fetch&output_format=json) Click here for sample JSON output.

A list of keys for various scan scenarios is provided

Scan Finished with Vulnerabilities

Scan Job

launch_date, active_hosts, total_hosts, type, status, reference, scanner_appliance, duration, scan_title, asset_groups, ips, excluded_ips, option_profile

Per Host

ip, dns, netbios, os, ip_status, qid, title, type, severity, port, protocol, fqdn, ssl, cve_id, vendor_reference, bugtraq_id, cvss_base, cvss_temporal, cvss3_base, cvss3_temporal, threat, impact, solution, exploitability, associated_malware, results, pci_vuln, instance, os_cpe, category, instance

If PCI is Enabled

pci_vuln

Host Stats

target_distribution_across_scanner_appliances
hosts_not_scanned_excluded_host_ip
hosts_not_scanned_host_not_alive_ip
hosts_not_scanned_host_not_alive_dns
hosts_not_scanned_host_not_alive_netbios
hosts_not_scanned_hostname_not_found_ip
hosts_not_scanned_scan_discontinued_ip
hosts_not_scanned_scan_discontinued_netbios_instace_ids
hosts_not_scanned_scan_discontinued_netbios_dns
hosts_not_scanned_scan_discontinued_netbios
hosts_not_scanned_dns_hostname_could_not_be_resolved
hosts_not_scanned_netbios_could_not_be_resolved
no_vulnerabilities_match_your_filters_for_these_hosts

hosts_not_scanned_dns_could_not_be_resolved
hosts_not_scanned_ip_could_not_be_resolved
hosts_not_scanned_hostname_not_found_netbios
hosts_not_scanned_hostname_not_found_dns

Scan Cancelled

Scan Job

launch_date, active_hosts, total_hosts, type, status, reference, scanner_appliance, duration, scan_title, asset_groups, ips, excluded_ips, option_profile

Host Stats

no_vulnerabilities_match_your_filters_for_these_hosts

host_not_scanned,_scan_canceled_by_user_ip_
host_not_scanned,_scan_canceled_by_administrator_ip_
host_not_scanned,_scan_canceled_by_service_ip_
host_not_scanned,_scan_canceled_by_unknown_ip_

host_not_scanned,_scan_canceled_by_user, (#No of IP) hosts
host_not_scanned,_scan_canceled_by_administrator, (#No of IP) hosts
host_not_scanned,_scan_canceled_by_service, (#No of IP) hosts
host_not_scanned,_scan_canceled_by_unknown, (#No of IP) hosts

host_not_scanned,_scan_canceled_by_user_dns_
host_not_scanned,_scan_canceled_by_administrator_dns_
host_not_scanned,_scan_canceled_by_service_dns_
host_not_scanned,_scan_canceled_by_unknown_dns_

host_not_scanned,_scan_canceled_by_user_instance_ids_
host_not_scanned,_scan_canceled_by_administrator_instance_ids_
host_not_scanned,_scan_canceled_by_service_instance_ids_
host_not_scanned,_scan_canceled_by_unknown_instance_ids_

host_not_scanned,_scan_canceled_by_user, dns,(#No of DNS) hosts
host_not_scanned,_scan_canceled_by_administrator,  dns,(#No of DNS) hosts
host_not_scanned,_scan_canceled_by_service, dns,(#No of DNS) hosts
host_not_scanned,_scan_canceled_by_unknown, dns,(#No of DNS) hosts

host_not_scanned,_scan_canceled_by_user, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_canceled_by_administrator,  instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_canceled_by_service, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_canceled_by_unknown, instance_ids,(#No of DNS) hosts

host_not_scanned,_scan_canceled_by_user_netbios_
host_not_scanned,_scan_canceled_by_administrator_netbios_
host_not_scanned,_scan_canceled_by_service_netbios_
host_not_scanned,_scan_canceled_by_unknown_netbios_

host_not_scanned,_scan_canceled_by_user, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_canceled_by_administrator, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_canceled_by_service, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_canceled_by_unknown, netbios,(#No of Netbios) hosts

Scan Error

Scan Job

launch_date, active_hosts, total_hosts, type, status, reference, scanner_appliance, duration, scan_title, asset_groups, ips, excluded_ips, option_profile

Host Stats

no_vulnerabilities_match_your_filters_for_these_hosts

Scan Finished (Host Not Alive)

Scan Job

launch_date, active_hosts, total_hosts, type, status, reference, scanner_appliance, duration, scan_title, asset_groups, ips, excluded_ips, option_profile

Host Stats

target_distribution_across_scanner_appliances
hosts_not_scanned_host_not_alive_ip

Scan Paused

Scan Job

launch_date, active_hosts, total_hosts, type, status, reference, scanner_appliance, duration, scan_title, asset_groups, ips, excluded_ips, option_profile, network

Per Host

ip, dns, netbios, os, ip_status, qid, title, type, severity, port, protocol, fqdn, ssl, cve_id, vendor_reference, bugtraq_id, cvss_base, cvss_temporal, cvss3_base, cvss3_temporal, threat, impact, solution, exploitability, associated_malware, results, pci_vuln, instance, os_cpe, category

Host Stats

target_distribution_across_scanner_appliances
hosts_not_scanned_host_not_alive_ip
host_not_scanned,_scan_paused_by_service_ip_
no_vulnerabilities_match_your_filters_for_these_hosts

host_not_scanned,_scan_paused_by_user_ip_
host_not_scanned,_scan_paused_by_administrator_ip_
host_not_scanned,_scan_paused_by_service_ip_
host_not_scanned,_scan_paused_by_unknown_ip_

host_not_scanned,_scan_paused_by_user, (#No of IP) hosts
host_not_scanned,_scan_paused_by_administrator, (#No of IP) hosts
host_not_scanned,_scan_paused_by_service, (#No of IP) hosts
host_not_scanned,_scan_paused_by_unknown, (#No of IP) hosts

host_not_scanned,_scan_paused_by_user_dns_
host_not_scanned,_scan_paused_by_administrator_dns_
host_not_scanned,_scan_paused_by_service_dns_
host_not_scanned,_scan_paused_by_unknown_dns_

host_not_scanned,_scan_paused_by_user_instance_ids_
host_not_scanned,_scan_paused_by_administrator_instance_ids_
host_not_scanned,_scan_paused_by_service_instance_ids_
host_not_scanned,_scan_paused_by_unknown_instance_ids_

host_not_scanned,_scan_paused_by_user, dns,(#No of DNS) hosts
host_not_scanned,_scan_paused_by_administrator, dns,(#No of DNS) hosts
host_not_scanned,_scan_paused_by_service, dns,(#No of DNS) hosts
host_not_scanned,_scan_paused_by_unknown, dns,(#No of DNS) hosts

host_not_scanned,_scan_paused_by_user, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_paused_by_administrator, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_paused_by_service, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_paused_by_unknown, instance_ids,(#No of DNS) hosts

host_not_scanned,_scan_paused_by_user, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_paused_by_administrator, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_paused_by_service, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_paused_by_unknown, netbios,(#No of Netbios) hosts

host_not_scanned,_scan_paused_by_user_netbios_
host_not_scanned,_scan_paused_by_administrator_netbios_
host_not_scanned,_scan_paused_by_service_netbios_
host_not_scanned,_scan_paused_by_unknown_netbios_

Scan Interrupted

Scan Job

launch_date, active_hosts, total_hosts, type, status, reference, scanner_appliance, duration, scan_title, asset_groups, ips, excluded_ips, option_profile, network

Host Stats

no_vulnerabilities_match_your_filters_for_these_hosts

host_not_scanned,_scan_unknown_by_user_ip_
host_not_scanned,_scan_unknown_by_administrator_ip_
host_not_scanned,_scan_unknown_by_service_ip_
host_not_scanned,_scan_unknown_by_unknown_ip_

host_not_scanned,_scan_unknown_by_user_dns_
host_not_scanned,_scan_unknown_by_administrator_dns_
host_not_scanned,_scan_unknown_by_service_dns_
host_not_scanned,_scan_unknown_by_unknown_dns_

host_not_scanned,_scan_unknown_by_user_instance_ids_
host_not_scanned,_scan_unknown_by_administrator_instance_ids_
host_not_scanned,_scan_unknown_by_service_instance_ids_
host_not_scanned,_scan_unknown_by_unknown_instance_ids_

host_not_scanned,_scan_unknown_by_user, (#No of IP) hosts
host_not_scanned,_scan_unknown_by_administrator, (#No of IP) hosts
host_not_scanned,_scan_unknown_by_service, (#No of IP) hosts
host_not_scanned,_scan_unknown_by_unknown, (#No of IP) hosts

host_not_scanned,_scan_unknown_by_user, dns,(#No of DNS) hosts
host_not_scanned,_scan_unknown_by_administrator, dns,(#No of DNS) hosts
host_not_scanned,_scan_unknown_by_service, dns,(#No of DNS) hosts
host_not_scanned,_scan_unknown_by_unknown, dns,(#No of DNS) hosts

host_not_scanned,_scan_unknown_by_user, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_unknown_by_administrator, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_unknown_by_service, instance_ids,(#No of DNS) hosts
host_not_scanned,_scan_unknown_by_unknown, instance_ids,(#No of DNS) hosts

host_not_scanned,_scan_unknown_by_user_netbios_
host_not_scanned,_scan_unknown_by_administrator_netbios_
host_not_scanned,_scan_unknown_by_service_netbios_
host_not_scanned,_scan_unknown_by_unknown_netbios_

host_not_scanned,_scan_unknown_by_user, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_unknown_by_administrator, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_unknown_by_service, netbios,(#No of Netbios) hosts
host_not_scanned,_scan_unknown_by_unknown, netbios,(#No of Netbios) hosts

hosts not scanned, hostname not found, (#NumberOfNoTrackerIP) hosts
hosts not scanned, hostname not found, netbios,(#NumberOfNoTrackerNETBIOS) hosts
hosts not scanned, hostname not found, dns, (#NumberOfNoTrackerDNS) hosts
hosts not scanned, hostname not found, instance ids, (#NumberOfNoTrackerDNS) hosts

hosts_not_scanned_excluded_host_dns
hosts_not_scanned_excluded_host_instance_ids

hosts_not_scanned_excluded_host_netbios

hosts_not_scanned_host_not_alive_dns
hosts_not_scanned_host_not_alive_instance_ids

Sample JSON output

[
    {
        "scan_report_template_title": "Scan Results",
        "result_date": "06/29/2018 06:19:26",
        "company": "Qualys, Inc",
        "add1": "919 E Hillsdale Blvd,4th Floor",
        "add2": null,
        "city": "Foster City",
        "state": "California",
        "country": "United States of America",
        "zip": "94404",
        "name": "Mayur Mistry",
        "username": "mayur_mm",
        "role": "Manager"
    },
    {
        "scan_date": "09/29/2018 21:20:35",
        "active_hosts": null,
        "total_hosts": "457660",
        "type": "On Demand",
        "status": "Canceled",
        "reference": "scan/1527628838.16797",
        "scanner_appliance": "",
        "duration": "00:00:24",
        "scan_title": "My Scan",
        "asset_groups": "4.5LIPs",
        "ips": "10.10.0.0, 10.10.0.2, 10.10.0.4, 10.10.0.6",
        "excluded_ips": "",
        "option_profile": "Initial Options"
    },
    {
        "host_not_scanned,_scan_canceled_by_user_ip_": "10.10.0.0,  10.10.0.2,  10.10.0.4,  10.10.0.6"
    }
]