Run Asset Search Report
Click here to see this page in full context

Run Asset Search Report

POST/api/2.0/fo/report/asset/?action=search

Launch reports in the user's account. The Report Share feature must be enabled in the user's subscription.

Permissions - Managers and Auditors can launch reports on all assets in the subscription, Unit Managers can launch reports on assets in their own business unit, Scanners and Readers can launch reports on assets in their own account.

Input ParametersInput Parameters

Click here to view parameters for running asset search reports.

Sample - Run Asset Search ReportSample - Run Asset Search Report

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl" "https://<qualys_base_url>/api/2.0/fo/report/asset/?action=search&output_format=xml&echo_request=1&ips=10.10.10.10-10.10.10.20"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE ASSET_SEARCH_REPORT SYSTEM 
"https://<qualys_base_url>/asset_search_report_v2.dtd">
<ASSET_SEARCH_REPORT>
    <HEADER>
        <COMPANY><![CDATA[qualys]]></COMPANY>
        <USERNAME>POC Manager</USERNAME>
        <GENERATION_DATETIME>2018-11-06T00:42:13Z</GENERATION_DATETIME>
        <TOTAL>26</TOTAL>
        <FILTERS>
        <ASSET_GROUPS>
        <ASSET_GROUP_TITLE><![CDATA[Winodws 7 Scap]]>
        </ASSET_GROUP_TITLE>
        </ASSET_GROUPS>
        <FILTER_LAST_SCAP_SCAN_DATE><![CDATA[Within 300]]>
        </FILTER_LAST_SCAP_SCAN_DATE>
        </FILTERS>
       </HEADER>
       <HOST_LIST>
        <HOST>
        <IP><![CDATA[10.10.10.10]]></IP>
        <TRACKING_METHOD>IP address</TRACKING_METHOD>
        <DNS><![CDATA[bridge.qualys.com]]></DNS>
        <NETBIOS><![CDATA[WIN7-10-10]]>
            <?xml version="1.0" encoding="UTF-8" ?>
            <!DOCTYPE ASSET_SEARCH_REPORT SYSTEM "https://<qualys_base_url>/asset_search_report_v2.dtd">
            <ASSET_SEARCH_REPORT>
            <HEADER>
              <REQUEST>
                <DATETIME>2018-06-03T20:21:13Z</DATETIME>
                <USER_LOGIN>user@123</USER_LOGIN>
                 <RESOURCE>https://<qualys_base_url>/api/2.0/fo/report/asset/
                 </RESOURCE>
                <PARAM_LIST>
                  <PARAM>
                    <KEY>action</KEY>
                    <VALUE>search</VALUE>
                  </PARAM>
                  <PARAM>
                    <KEY>output_format</KEY>
                    <VALUE>xml</VALUE>
                  </PARAM>
                  <PARAM>
                    <KEY>echo_request</KEY>
                    <VALUE>1</VALUE>
                  </PARAM>
                  <PARAM>
                    <KEY>ips</KEY>
                    <VALUE>10.10.10.10-10.10.10.15</VALUE>
                  </PARAM>
                </PARAM_LIST>
              </REQUEST>
              <COMPANY>Corsa</COMPANY>
              <USERNAME>user@123</USERNAME>
              <GENERATION_DATETIME>2018-06-03T20:21:13Z</GENERATION_DATETIME>
              <TOTAL>2</TOTAL>
              <FILTERS>
                <IP_LIST>
                  <RANGE>
                    <START>10.10.10.10</START>
                    <END>10.10.10.15</END>
                  </RANGE>
                </IP_LIST>
              </FILTERS>
            </HEADER>
            <HOST_LIST>
              <HOST>
                <IP><![CDATA[10.10.10.10]]></IP>
                <TRACKING_METHOD>IP address</TRACKING_METHOD>
                <OPERATING_SYSTEM><![CDATA[Linux 2.4-2.6 / Embedded Device / F5 Networks Big-IP]]></OPERATING_SYSTEM>
                <LAST_SCAN_DATE>2018-06-03T09:11:21Z</LAST_SCAN_DATE>
                <FIRST_FOUND_DATE>2018-06-03T07:11:46Z</FIRST_FOUND_DATE>
              </HOST>
              <HOST>
                <IP><![CDATA[10.10.10.11]]></IP>
                <TRACKING_METHOD>IP address</TRACKING_METHOD>
                <DNS><![CDATA[10-10-10-11.bogus.tld]]></DNS>
                <NETBIOS><![CDATA[SYS_10_10_10_11]]></NETBIOS>
                <OPERATING_SYSTEM><![CDATA[Windows 2000 Server Service Pack 4]]></OPERATING_SYSTEM>
                <LAST_SCAN_DATE>2018-06-03T07:12:47Z</LAST_SCAN_DATE>
                <LAST_COMPLIANCE_SCAN_DATE>20186-05-13T21:15:01Z</LAST_COMPLIANCE_SCAN_DATE>
                <FIRST_FOUND_DATE>2018-05-12T15:16:54Z</FIRST_FOUND_DATE>
              </HOST>
            </HOST_LIST>
            </ASSET_SEARCH_REPORT></NETBIOS>
        <OPERATING_SYSTEM><![CDATA[Windows 7 Ultimate 64 bit Edition 
       Service Pack 1]]></OPERATING_SYSTEM>
        <OS_CPE><![CDATA[cpe:/o:microsoft:windows_7::sp1:x64-
       ultimate:]]></OS_CPE>
        <LAST_SCAN_DATE>2018-10-18T20:55:10Z</LAST_SCAN_DATE>
        <LAST_COMPLIANCE_SCAN_DATE>2018-09-
       14T21:57:53Z</LAST_COMPLIANCE_SCAN_DATE>
        <LAST_SCAP_SCAN_DATE>2018-08-
       28T10:57:06Z</LAST_SCAP_SCAN_DATE>
        <FIRST_FOUND_DATE>2018-04-03T23:18:26Z</FIRST_FOUND_DATE>
        </HOST>

Sample - Asset Search Report CSVSample - Asset Search Report CSV

CSV Output

----BEGIN_RESPONSE_HEADER_CSV
"Launch Datetime","User Login","Resource","Parameter 
Name","Parameter Value"
"2018-06-
07T22:51:23Z","john_sm","https://<qualys_base_url>/api/2.0/fo/r
eport/asset/",,
,,,"action","search"
,,,"output_format","csv"
,,,"echo_request","1"
,,,"ips","10.10.10.10-10.10.10.20"
----END_RESPONSE_HEADER_CSV
"Company","UserName","ReportDate","AssetGroups","IPAddresses","DNS
Hostname","NetBIOSHostname","TargetTrackingMethod","TargetOperatin
gSystem","TargetService","TargetPort","TargetQID","QIDTitle","Targ
etLastScanDate","TargetFirstFoundDate","OSCPE","Tags","TargetCompl
ianceLastScanDate","Total"
"Corsa","John Smith","2018-06-07T22:51:23Z",,"10.10.10.10-
10.10.10.20",,,,,,,,,,,,,,"2"
"IP","DNSHostname","NetBIOSHostname","OperatingSystem","OSCPE","Po
rt/Service/Default 
Service","TrackingMethod","LastScanDate","LastComplianceScanDate",
"First Found","Tags"
"10.10.10.10",,,"Linux 2.4-2.6 / Embedded Device / F5 Networks 
Big-IP",,,"IP address","2018-06-03T09:11:21Z",,"2018-06-
03T07:11:46Z",
"10.10.10.11",,"SYS_10_10_10_11",,,,"IP address","2018-06-
03T07:12:47Z","2018-05-13T21:15:01Z","2018-05-12T15:16:54Z",

Sample - Asset Search Report in XML Output for Azure VM InstancesSample - Asset Search Report in XML Output for Azure VM Instances

This sample will return the asset search report in XML format. In XML output, you’ll see these Azure VM instance specific tags: FILTER_AZURE_VM_ID, FILTER_AZURE_VM_STATE with Azure filter values.

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl" "https://<qualys_base_url>/api/2.0/fo/report/asset/?action=search&asse t_groups=All&azure_vm_id=399af5dc-c32a-4c40-95a5- c6ed0e786430&azure_vm_id_modifier=beginning+with&tracking_method=AZURE+VM &azure_vm_state=RUNNING&output_format=xml"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE ASSET_SEARCH_REPORT SYSTEM
"https://<qualys_base_url>/asset_search_report_v2.dtd">
<ASSET_SEARCH_REPORT>
<HEADER>
 <COMPANY><![CDATA[Qualys]]></COMPANY>
 <USERNAME>user@123</USERNAME>
 <GENERATION_DATETIME>2020-06-22T23:24:25Z</GENERATION_DATETIME>
 <TOTAL>1</TOTAL>
 <FILTERS>
 <ASSET_GROUPS>
 <ASSET_GROUP_TITLE><![CDATA[All]]></ASSET_GROUP_TITLE>
 </ASSET_GROUPS>
 <FILTER_AZURE_VM_ID><![CDATA[Beginning With 399af5dc-c32a-4c40-95a5-
c6ed0e786430]]></FILTER_AZURE_VM_ID>
 <TRACKING_METHOD><![CDATA[Azure VM]]></TRACKING_METHOD>
 <FILTER_AZURE_VM_STATE><![CDATA[RUNNING]]></FILTER_AZURE_VM_STATE>
 </FILTERS>
</HEADER>
<HOST_LIST>
 <HOST>
 <IP><![CDATA[10.4.8.4]]></IP>
 <TRACKING_METHOD>Azure VM</TRACKING_METHOD>
 <CLOUD_PROVIDER>Azure</CLOUD_PROVIDER>
 <CLOUD_SERVICE>VM</CLOUD_SERVICE>
 <CLOUD_RESOURCE_ID><![CDATA[399af5dc-c32a-4c40-95a5-
c6ed0e786430]]></CLOUD_RESOURCE_ID>
 <!-- <EC2_INSTANCE_ID> tag has been deprecated. Please refer to
<CLOUD_RESOURCE_ID> tag for the same information //-->
 <EC2_INSTANCE_ID><![CDATA[399af5dc-c32a-4c40-95a5-
c6ed0e786430]]></EC2_INSTANCE_ID>
...

Sample - Search EC2 Assets by Instance IDSample - Search EC2 Assets by Instance ID

API Request

curl -u "USERNAME:PASSWORD" -k -H "X-Requested-With: Curl" -d "action=search&output_format=xml&tracking_method=EC2&use_tags=1&tag_set_by=name&tag_set_include=useasttag&ec2_instance_id=i-0fb7086f985856fa4&ec2_instance_id_modifier=containing" "https://<qualys_base_url>/api/2.0/fo/report/asset/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE ASSET_SEARCH_REPORT SYSTEM "https://<qualys_base_url>/asset_search_report_v2.dtd">
<ASSET_SEARCH_REPORT>
<HEADER>
  <COMPANY><![CDATA[qualys-test]]></COMPANY>
  <USERNAME>qualys_ps</USERNAME>
  <GENERATION_DATETIME>2018-04-11T10:17:32Z</GENERATION_DATETIME>
  <TOTAL>1</TOTAL>
  <FILTERS>
    <ASSET_TAGS>
      <INCLUDED_TAGS scope="any">
        <ASSET_TAG><![CDATA[useasttag]]></ASSET_TAG>
      </INCLUDED_TAGS>
    </ASSET_TAGS>
    <TRACKING_METHOD><![CDATA[EC2]]></TRACKING_METHOD>
  </FILTERS>
</HEADER>
<HOST_LIST>
  <HOST>
    <IP><![CDATA[10.73.188.6]]></IP>
    <HOST_TAGS><![CDATA[EC2, Virginia, agec2, sada-0117-targets, sada-new-0308, useasttag;
]]></HOST_TAGS>
    <TRACKING_METHOD>EC2</TRACKING_METHOD>
    <DNS><![CDATA[ip-10-73-188-6.ec2.internal]]></DNS>
    <EC2_INSTANCE_ID><![CDATA[i-0fb7086f985856fa4]]></EC2_INSTANCE_ID>
    <LAST_SCAN_DATE />
    <FIRST_FOUND_DATE />
  </HOST>
</HOST_LIST>

Sample - Search EC2 Assets With Certain StatusSample - Search EC2 Assets With Certain Status

API Request

curl -u "USERNAME:PASSWORD" -k -H "X-Requested-With: Curl" -d "action=search&output_format=xml&tracking_method=EC2&use_tags=1&tag_set_by=name&tag_set_include=useasttag&ec2_instance_status=TERMINATED&ec2_instance_id=i-0b121b9211d7e25cb&ec2_instance_id_modifier=containing" "https://<qualys_base_url>/api/2.0/fo/report/asset/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE ASSET_SEARCH_REPORT SYSTEM "https://<qualys_base_url>/asset_search_report_v2.dtd">
<ASSET_SEARCH_REPORT>
<HEADER>
  <COMPANY><![CDATA[qualys-test]]></COMPANY>
  <USERNAME>sada-customer customer</USERNAME>
  <GENERATION_DATETIME>2018-04-11T10:49:05Z</GENERATION_DATETIME>
  <TOTAL>1</TOTAL>
  <FILTERS>
    <ASSET_TAGS>
      <INCLUDED_TAGS scope="any">
        <ASSET_TAG><![CDATA[useasttag]]></ASSET_TAG>
      </INCLUDED_TAGS>
    </ASSET_TAGS>
    <TRACKING_METHOD><![CDATA[EC2]]></TRACKING_METHOD>
  </FILTERS>
</HEADER>
<HOST_LIST>
  <HOST>
    <IP><![CDATA[10.90.2.175]]></IP>
    <HOST_TAGS><![CDATA[EC2, Vriginia, sada-new-0308, useasttag;
]]></HOST_TAGS>
    <TRACKING_METHOD>EC2</TRACKING_METHOD>
    <DNS><![CDATA[i-0b121b9211d7e25cb]]></DNS>
    <EC2_INSTANCE_ID><![CDATA[i-0b121b9211d7e25cb]]></EC2_INSTANCE_ID>
    <LAST_SCAN_DATE />
    <FIRST_FOUND_DATE />
  </HOST>
</HOST_LIST>

Sample - Search Assets with SCAP Scan PerformedSample - Search Assets with SCAP Scan Performed

API Request

curl -u "username:password" -H "X-Requested-With:" "action=search&output_format=xml&asset_groups=Winodws+7+Scap&last_ scap_scan_days=300&last_scap_scan_modifier=within" "https://<qualys_base_url>/api/2.0/fo/report/asset/"

XML Output

<COMPANY><![CDATA[qualys-test]]></COMPANY>
  <USERNAME>user@123</USERNAME>
  <GENERATION_DATETIME>2018-04-11T10:49:05Z</GENERATION_DATETIME>
  <TOTAL>1</TOTAL>
  <FILTERS>
    <ASSET_TAGS>
      <INCLUDED_TAGS scope="any">
        <ASSET_TAG><![CDATA[useasttag]]></ASSET_TAG>
      </INCLUDED_TAGS>
    </ASSET_TAGS>
    <TRACKING_METHOD><![CDATA[EC2]]></TRACKING_METHOD>
  </FILTERS>
</HEADER>
<HOST_LIST>
  <HOST>
    <IP><![CDATA[10.90.2.175]]></IP>
    <HOST_TAGS><![CDATA[EC2, Vriginia, sada-new-0308, useasttag;
]]></HOST_TAGS>
    <TRACKING_METHOD>EC2</TRACKING_METHOD>
    <DNS><![CDATA[i-0b121b9211d7e25cb]]></DNS>
    <EC2_INSTANCE_ID><![CDATA[i-0b121b9211d7e25cb]]></EC2_INSTANCE_ID>
    <LAST_SCAN_DATE />
    <FIRST_FOUND_DATE />
  </HOST>
</HOST_LIST>

DTD

<platform API server>/asset_search_report_v2.dtd