List VM Scans
Click to view navigation pane


List VM Scans

For API version information, refer to the API Version History Section.

V2.0| V3.0

V2.0

GET POST/api/2.0/fo/scan/?action=list

List VM scans in the user's account. By default scans launched in the past 30 days are listed.

 When the Unit Manager runs the API for the scan list, the count differs from what appears on the Scan List page in the UI (Scans > Scans). This discrepancy occurs due to the in-scope scan list enabled by default in the API and the Show in Scope Scan List option disabled in the VM UI.

Input ParametersInput Parameters

Click here to view all scan list parameters.

Sample - List All VM ScansSample - List All VM Scans

API Request

curl --location 'https://<qualys_base_url>//api/2.0/fo/scan/?action=list&echo_request=1&show_ags=1&show_op=1' \
--header 'X-Requested-With: 
32.227 HA' \
--header 'User-Agent: 
32.227 HA/1.0.0 (https://
32.227 HA.com)' \
--header 'Authorization: Basic Encoded username:passwordstring' \
--header 'Accept: /' \
--header 'Host: 
32.227 HA.com:43000' \
--header 'Connection: keep-alive'

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SCAN_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/scan/scan_list_output.dtd">
<SCAN_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2025-01-09T10:21:25Z</DATETIME>
        <SCAN_LIST>
            <SCAN>
                <REF>scan/1736361211.27337</REF>
                <TYPE>Scheduled</TYPE>
                <TITLE>
                    <![CDATA[Cloud Perimeter Scan 20250106-141228]]>
                </TITLE>
                <USER_LOGIN>vmsp_ag1</USER_LOGIN>
                <LAUNCH_DATETIME>2025-01-08T18:33:31Z</LAUNCH_DATETIME>
                <DURATION>00:29:43</DURATION>
                <PROCESSING_PRIORITY>0 - No Priority</PROCESSING_PRIORITY>
                <PROCESSED>1</PROCESSED>
                <STATUS>
                    <STATE>Finished</STATE>
                    <SUB_STATE>No_Vuln</SUB_STATE>
                </STATUS>
                <TARGET>
                    <![CDATA[abc.com]]>
                </TARGET>
                <OPTION_PROFILE>
                    <TITLE>
                        <![CDATA[Initial Options]]>
                    </TITLE>
                    <DEFAULT_FLAG>0</DEFAULT_FLAG>
                </OPTION_PROFILE>
            </SCAN>
         <SCAN_LIST>
      <RESPONSE>
<SCAN_LIST_OUTPUT>

Sample - List All Running Scans That Were Launched by the User with the Login ID “acme_ab”:Sample - List All Running Scans That Were Launched by the User with the Login ID “acme_ab”:

API Request

curl -H "X-Requested-With: Curl Sample" -b "QualysSession=71e6cda2a35d2cd404cddaf305ea0208; path=/api; secure" "https://<qualys_base_url>/api/2.0/fo/scan/ ?action=list&state=Running&user_login=acme_ab"

Sample - List All Scheduled Scans That Were Launched After June 5, 2018Sample - List All Scheduled Scans That Were Launched After June 5, 2018

API Request

curl -H "X-Requested-With: Curl Sample" -b "QualysSession=71e6cda2a35d2cd404cddaf305ea0208; path=/api; secure" "https://<qualys_base_url>/api/2.0/fo/scan/ ?action=list&type=Scheduled&launched_after_datetime=2018-06-05"

Sample - List All Scans for AFCO Company Client (Only for Consultant Type Subscriptions)Sample - List All Scans for AFCO Company Client (Only for Consultant Type Subscriptions)

API Request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml""https://<qualys_base_url>/api/2.0/fo/scan/?action=lis t&client_name=AFCO Company"

DTD

<platform API server>/api/2.0/fo/scan/scan_list_output.dtd

V3.0

GET POST/api/3.0/fo/scan/?action=list

List VM scans in the user's account. By default scans launched in the past 30 days are listed.

 When the Unit Manager runs the API for the scan list, the count differs from what appears on the Scan List page in the UI (Scans > Scans). This discrepancy occurs due to the in-scope scan list enabled by default in the API and the Show in Scope Scan List option disabled in the VM UI.

Input ParametersInput Parameters

Click here to view all scan list parameters.

List All VM ScansList All VM Scans

API Request

curl --location 'https://<qualys_base_url>//api/2.0/fo/scan/?action=list&echo_request=1&show_ags=1&show_op=1' \
--header 'X-Requested-With: 
32.227 HA' \
--header 'User-Agent: 
32.227 HA/1.0.0 (https://
32.227 HA.com)' \
--header 'Authorization: Basic Encoded username:passwordstring' \
--header 'Accept: /' \
--header 'Host: 
32.227 HA.com:43000' \
--header 'Connection: keep-alive'

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SCAN_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/scan/scan_list_output.dtd">
<SCAN_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2025-01-09T10:21:25Z</DATETIME>
        <SCAN_LIST>
            <SCAN>
                <REF>scan/1736361211.27337</REF>
                <TYPE>Scheduled</TYPE>
                <TITLE>
                    <![CDATA[Cloud Perimeter Scan 20250106-141228]]>
                </TITLE>
                <USER_LOGIN>vmsp_ag1</USER_LOGIN>
                <LAUNCH_DATETIME>2025-01-08T18:33:31Z</LAUNCH_DATETIME>
                <DURATION>00:29:43</DURATION>
                <PROCESSING_PRIORITY>0 - No Priority</PROCESSING_PRIORITY>
                <PROCESSED>1</PROCESSED>
                <STATUS>
                    <STATE>Finished</STATE>
                    <SUB_STATE>No_Vuln</SUB_STATE>
                </STATUS>
                <TARGET>
                    <![CDATA[abc.com]]>
                </TARGET>
                <OPTION_PROFILE>
                    <TITLE>
                        <![CDATA[Initial Options]]>
                    </TITLE>
                    <DEFAULT_FLAG>0</DEFAULT_FLAG>
                </OPTION_PROFILE>
            </SCAN>
         <SCAN_LIST>
      <RESPONSE>
<SCAN_LIST_OUTPUT>

Sample - List All Running Scans That Were Launched by the User with the Login ID “acme_ab”:Sample - List All Running Scans That Were Launched by the User with the Login ID “acme_ab”:

API Request

curl -H "X-Requested-With: Curl Sample" -b "QualysSession=71e6cda2a35d2cd404cddaf305ea0208; path=/api; secure" "https://<qualys_base_url>/api/3.0/fo/scan/ ?action=list&state=Running&user_login=acme_ab"

Sample - List All Scheduled Scans That Were Launched After June 5, 2018Sample - List All Scheduled Scans That Were Launched After June 5, 2018

API Request

curl -H "X-Requested-With: Curl Sample" -b "QualysSession=71e6cda2a35d2cd404cddaf305ea0208; path=/api; secure" "https://<qualys_base_url>/api/3.0/fo/scan/ ?action=list&type=Scheduled&launched_after_datetime=2018-06-05"

Sample - List All Scans for AFCO Company Client (Only for Consultant Type Subscriptions)Sample - List All Scans for AFCO Company Client (Only for Consultant Type Subscriptions)

API Request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml""https://<qualys_base_url>/api/3.0/fo/scan/?action=lis t&client_name=AFCO Company"

Sample - List the launched Azure internal scanSample - List the launched Azure internal scan

API Request

curl --location 'https://<qualys_base_url>/api/3.0/fo/scan/?action=list' \
--header 'X-Requested-With: 
32.227 HA' \
--header 'User-Agent: 
32.227 HA/1.0.0 (https://
32.227 HA.com)' \
--header 'Authorization: Basic Encoded username:passwordstring' \
--header 'Accept: /' \
--header 'Host: 
32.227 HA:43000' \
--header 'Connection: keep-alive'

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SCAN_LIST_OUTPUT SYSTEM "//<qualys_base_url>/api/3.0/fo/scan/scan_list_output.dtd">
<SCAN_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2024-12-09T09:11:17Z</DATETIME>
        <SCAN_LIST>
            <SCAN>
                <REF>scan/1735543972.16308</REF>
                <TYPE>Scheduled</TYPE>
                <TITLE>
                    <![CDATA[Azure Scan Internal Test]]>
                </TITLE>
                <USER_LOGIN>vmsp_ag1</USER_LOGIN>
                <LAUNCH_DATETIME>2024-12-30T07:32:52Z</LAUNCH_DATETIME>
                <DURATION>00:00:27</DURATION>
                <PROCESSING_PRIORITY>2 - Ultimate</PROCESSING_PRIORITY>
                <PROCESSED>1</PROCESSED>
                <STATUS>
                    <STATE>Finished</STATE>
                    <SUB_STATE>No_Host</SUB_STATE>
                </STATUS>
                <TARGET>
                    <![CDATA[65188eb1-02b7-405e-861c-fb44c98a20d7,cc681b26-8899-4ca8-bedd-b187bdbb8bdb,86c32f80-df08-4d55-883d-dc1be958b404,4518d470-2c51-4b36-a2f8-c160b84a3145,b119496c-008c-44cb-845a-928f22368776,e79b48ab-e76d-4ce0-a2c7-f55cafb8214b,2fad044a-5a20-408d-a24c-ec82db6b480a,8332f07d-ae8c-4ecf-81b1-b518b9c93b73,06ac9d58-bac5-452c-b7d9-2bcc6a65f462,ee50296b-bd55-4806-ae44-a741a8429980,01140268-3adf-48fb-87c3-e7f267ba06b8,7d97c6e6-94c1-4dfb-834b-1372bed7f460,c24f8498-b2a9-4eb6-90be-a2a1cce1c8fe,abf4867d-7d9a-49e2-af91-74a0a07ad78e,8040afd7-faae-48cc-8721-0effdba065d9,806d9fbd-b3c5-47e6-b75d-af452c85d52c,de9edb26-9fd6-48a9-82bd-0563e6c73c8c,45ecfa8b-5761-44e3-ba19-7c5a1c5b5fd1,e2ef6795-79ef-45ff-a6d2-c6f23498578c,81deef30-3247-4617-8539-98ff74b4b809,86258819-4965-406b-87b7-c171dfa27740,8debc341-ddfc-4ceb-a505-293092ee0235,3a6121a9-52ff-4c9a-a4cb-c998f8e1128b,8a1feb05-6bd1-447b-9d81-a9df8d08fc6a,da029994-08ed-4fe9-9d18-730e52668724,46cdd666-ed4d-4caa-a4f8-dc0de9840e33,a6b86d01-86d4-4e33-9966-6223c6f26577,cbaeb49d-a885-4fc1-ac19-fe65bcc92e58,ba47a438-a5ef-4487-a457-00624bd98fe7,0ad0ef2b-e4bd-462b-be2e-9d363f03c8a4,209e9fad-455d-4755-b884-87f538daa76d,2019b43a-155f-49b8-bf43-52092b87a6ab,1523ecc7-fb13-4320-99c8-09800730fec9,57b01662-8754-4764-842f-c9ce982924c6,c6419606-a6f0-4340-84f3-1be040384a54,3ee18bbf-54cf-4466-9c51-08cde3f43b1a,a24ab800-6752-440e-b15f-f8d652f56325,e60ab9f6-45f7-47d3-aeee-f2f6848a9137,8cc39bd5-42ef-4cfc-a671-446228bdcd56,c97a9971-a52a-48fa-a202-af3c2f76b623,aa887200-c6a9-435b-91bd-4fd8aa7b3166]]>
                </TARGET>
            </SCAN>
        </SCAN_LIST>
    </RESPONSE>
</SCAN_LIST_OUTPUT>

Sample - To fetch a specific launched Azure internal scanSample - To fetch a specific launched Azure internal scan

API Request

curl --location 'https://<qualys_base_url>/api/3.0/fo/scan/?action=list&show_ags=1&show_op=1' \
--header 'X-Requested-With: badsawewbu' \
--header 'User-Agent: 
32.227 HA/1.0.0 (https://
32.227 HA.com)' \
--header 'Authorization: Encoded username:passwordstring' \
--header 'Accept: /' \
--header '
32.227 HA.qualys.com:43000' \
--header 'Connection: keep-alive'

JSON Output

    [{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":38711,"instance":null,"result":"Hops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t11.11.1.11\t1.91ms\tICMPHops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t11.11.1.11\t1.91ms\tICMP"},
{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":14013,"instance":null,"result":"Port\tIANA
Assigned Ports\/Services\tDescription\tService Detected\n111\tsunrpc\tSUN Remote Procedure Call\trpc
udp\n2049\tshilp\tshilp\tnfsPort\tIANA Assigned Ports\/Services\tDescription\tService Detected\n111\tsunrpc\tSUN Remote
Procedure Call\trpc udp\n2049\tshilp\tshilp\tnfs"},
{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":20220,"instance":null,"result":"Hops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t11.11.1.11\t1.91ms\tICMPHops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t11.11.1.11\t1.91ms\tICMP"},
{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":45266,"instance":null,"result":"Port\tIANA
Assigned Ports\/Services\tDescription\tService Detected\n111\tsunrpc\tSUN Remote Procedure Call\trpc
udp\n2049\tshilp\tshilp\tnfsPort\tIANA Assigned Ports\/Services\tDescription\tService Detected\n111\tsunrpc\tSUN Remote
Procedure Call\trpc udp\n2049\tshilp\tshilp\tnfs"},
{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":48074,"instance":null,"result":"Hops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t10.14.9.80\t1.91ms\tICMPHops\tIP\tRound
Trip Time\tProbe\n1\t10.40.1.2\t0.19ms\tICMP\n2\t10.10.0.10\t0.26ms\tICMP\n3\t10.14.9.80\t1.91ms\tICMP"},
{"ip":"10.14.9.80","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":45268,"instance":null,"result":"Hops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t11.11.1.11\t1.91ms\tICMPHops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t11.11.1.11\t1.91ms\tICMP"},
{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":45304,"instance":null,"result":""},
{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":242738,"instance":null,"result":"Hops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t10.6.1.36\t1.91ms\tICMP"},
{"ip":"11.11.1.11","dns":"27f86f78-8dc2-4093-abed-1ce3b648c241","netbios":null,"qid":45376,"instance":null,"result":"Hops\tIP\tRound
Trip Time\tProbe\n1\t11.11.1.11\t0.19ms\tICMP\n2\t11.11.1.11\t0.26ms\tICMP\n3\t11.11.1.11\t1.91ms\tICMP"}]

DTD

<platform API server>/api/3.0/fo/scan/scan_list_output.dtd

API Version History

The following table depicts the information about the different versions of this API along with the status:

API Version API Status Release Date
/api/2.0/fo/scan/?action=list To be deprecated June 2025
/api/3.0/fo/scan/?action=list Active January 2025

 

 

Was this topic helpful?

success Thank you! We're glad to hear that this topic was useful.
success We appreciate your feedback. We'll work to make this topic better for you in the future.