Manage PC Scans

/api/2.0/fo/scan/compliance/?action={action}

Various actions you can take on PC scans i.e. cancel, pause, resume, delete, fetch.

Input ParametersInput Parameters

Parameter	Required/Optional	Data Type	Description
action={value}	Required	String	One of these actions cancel - Stop a scan in progress (POST) pause - Pause a scan in progress (POST) resume - Restart a scan that has been paused (POST) delete - Delete a scan (POST) fetch - Download scan results when scan has status Finished, Canceled, Paused or Error (GET or POST)
echo_request={0\|1}	Optional	Integer	Specify 1 to view (echo) input parameters in the XML output. By default these are not included.
scan_ref={value}	Required	String	The scan reference of a scan. The scan status of this scan must be finished.

Parameter

Required/Optional

Data Type

Description

action={value}

Required

String

One of these actions

cancel - Stop a scan in progress (POST)

pause - Pause a scan in progress (POST)

resume - Restart a scan that has been paused (POST)

delete - Delete a scan (POST)

fetch - Download scan results when scan has status Finished, Canceled, Paused or Error (GET or POST)

echo_request={0|1}

Optional

Integer

Specify 1 to view (echo) input parameters in the XML output. By default these are not included.

scan_ref={value}

Required

String

The scan reference of a scan. The scan status of this scan must be finished.

Sample - Fetch PC Scan ResultsSample - Fetch PC Scan Results

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -X "POST" -d "action=fetch&scan_ref=compliance/1600333077.13214" "https://<qualys_base_url>/api/2.0/fo/scan/compliance/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE COMPLIANCE_SCAN_RESULT_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/scan/compliance/compliance_scan_result_output.dtd">
<COMPLIANCE_SCAN_RESULT_OUTPUT>
  <RESPONSE>
    <DATETIME>2020-09-17T09:48:48Z</DATETIME>
    <COMPLIANCE_SCAN>
      <HEADER>
        <NAME><![CDATA[Compliance Scan Results]]></NAME>
        <GENERATION_DATETIME>2020-09-17T09:48:48Z</GENERATION_DATETIME>
        <COMPANY_INFO>
          <NAME><![CDATA[Qualys]]></NAME>
          <ADDRESS><![CDATA[1600 Bridge Parkway]]></ADDRESS>
          <CITY><![CDATA[Redwood Shores]]></CITY>
          <STATE><![CDATA[California]]></STATE>
          <COUNTRY><![CDATA[United States of America]]></COUNTRY>
          <ZIP_CODE><![CDATA[94065]]></ZIP_CODE>
        </COMPANY_INFO>
        <USER_INFO>
          <NAME><![CDATA[quays_jdoe]]></NAME>
          <USERNAME>jdoe</USERNAME>
          <ROLE>Manager</ROLE>
        </USER_INFO>
        <KEY value="USERNAME">jdoe</KEY>
        <KEY value="COMPANY"><![CDATA[Qualys]]></KEY>
        <KEY value="DATE">2020-09-17T08:59:59Z</KEY>
        <KEY value="TITLE"><![CDATA[Scan by DNS With FQDN only on cust NW]]></KEY>
        <KEY value="TARGET">domain1.qualys.com, domain2.qualys.com</KEY>
        <KEY value="EXCLUDED_TARGET"><![CDATA[N/A]]></KEY>
        <KEY value="NETWORK_ID"><![CDATA[164091]]></KEY>
        <KEY value="NETWORK_TITLE"><![CDATA[Swati - Network 1]]></KEY>
        <KEY value="DURATION">00:03:47</KEY>
        <KEY value="SCAN_HOST">SV_VScanner1 (Scanner 12.0.35-1, Vulnerability Signatures 2.4.976-2)</KEY>
        <KEY value="NBHOST_ALIVE">2</KEY>
        <KEY value="NBHOST_TOTAL">2</KEY>
        <KEY value="REPORT_TYPE">On-demand</KEY>
        <KEY value="OPTIONS">Scanned Ports: Targeted Scan, Hosts to Scan in Parallel - External Scanners: 15, Hosts to Scan in Parallel - Scanner Appliances: 30, Total Processes to Run in Parallel: 10, HTTP Processes to Run in Parallel: 10, Packet (Burst) Delay: Medium, Intensity: Normal, Overall Performance: Normal, ICMP Host Discovery, Ignore RST packets: Off, Ignore firewall-generated SYN-ACK packets: Off, Do not send ACK or SYN-ACK packets during host discovery: Off</KEY>
        <KEY value="STATUS">FINISHED</KEY>
        <FQDNS>
          <FQDN><![CDATA[domain1.qualys.com]]></FQDN>
          <FQDN><![CDATA[domain2.qualys.com]]></FQDN>
        </FQDNS>
        <OPTION_PROFILE>
          <OPTION_PROFILE_TITLE option_profile_default="0"><![CDATA[Initial PC Options]]></OPTION_PROFILE_TITLE>
        </OPTION_PROFILE>
      </HEADER>
      <APPENDIX>
        <TARGET_HOSTS />
        <TARGET_DISTRIBUTION>
          <SCANNER>
            <NAME><![CDATA[SV_VScanner1]]></NAME>
            <HOSTS>domain1.qualys.com, domain2.qualys.com</HOSTS>
          </SCANNER>
        </TARGET_DISTRIBUTION>
        <OS_AUTH_BASED_TECHNOLOGY_LIST />
      </APPENDIX>
    </COMPLIANCE_SCAN>
  </RESPONSE>
</COMPLIANCE_SCAN_RESULT_OUTPUT>

DTD

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