Run Asset Search Report

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

[POST]

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 Parameters

Click here to view parameters for running asset search reports.

Sample - run asset search report

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl" "https://qualysapi.qualys.com/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://qualysapi.qualys.com/asset_search_report_v2.dtd">

<ASSET_SEARCH_REPORT>

<HEADER>

  <REQUEST>

    <DATETIME>2018-06-03T20:21:13Z</DATETIME>

    <USER_LOGIN>john_sm</USER_LOGIN>

     <RESOURCE>https://qualysapi.qualys.com/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>John Smith</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>

 

Sample - 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://qualysapi.qualys.com/api/2.0/fo/report/asset/"

 

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE ASSET_SEARCH_REPORT SYSTEM "https://qualysapi.qualys.com/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 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://qualysapi.qualys.com/api/2.0/fo/report/asset/"

 

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE ASSET_SEARCH_REPORT SYSTEM "https://qualysapi.qualys.com/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>

 

 

DTD

<platform API server>/asset_search_report_v2.dtd