Delete Virtual Scanner

POST/api/2.0/fo/appliance/?action=delete

Delete a virtual scanner appliance in the user's account. Deletion results in these actions: 1) the scanner will be removed from associated asset groups, and 2) scheduled scans using this scanner will be deactivated.

Is your virtual scanner running scans? If yes it’s not possible to delete it. We recommend you check to be sure the virtual scanner you want to delete is not running scans.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=delete

Required

String 

Specify action to delete virtual scanner.

echo_request={0|1}

Optional

Integer 

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

id={id}

Required

Integer 

A valid ID of a virtual scanner.

Sample - Delete Virtual ScannerSample - Delete Virtual Scanner

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -X "POST"-d "action=delete&echo_request=1&id=12345""https://<qualys_base_url>/api/2.0/fo/appliance/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE APPLIANCE_LIST_OUTPUT SYSTEM
"https://<qualys_base_url>/api/2.0/fo/simple_return.dtd">
<SIMPLE_RETURN>
    <RESPONSE>
        <DATETIME>2018-05-02T09:26:01Z</DATETIME>
        <TEXT>Virtual scanner deleted successfully</ID>
        <ITEM_LIST>
             <ITEM>
                  <KEY>ID<KEY>
                  <VALUE>115<VALUE>
             </ITEM>
             <ITEM>
                  <KEY>DEACTIVATED_SCHEDULED_SCANS<KEY>
                  <VALUE>None<VALUE>
             </ITEM>
             <ITEM>
                  <KEY>AFFECTED_ASSET_GROUPS<KEY>
                  <VALUE>None<VALUE>
             </ITEM>
        <ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>