List VM Scans

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.

Input ParametersInput Parameters

Click here to view all scan list parameters.

Sample - List All VM ScansSample - List All VM Scans

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&echo_request=1&show_ags=1&show_op=1"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-15T21:32:40Z</DATETIME>
    <TEXT>New vm scan launched</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>136992</VALUE>
      </ITEM>
      <ITEM>
        <KEY>REFERENCE</KEY>
        <VALUE>scan/1358285558.36992</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

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