Add a virtual scanner appliance to the user's account.
Permissions - This API is available to Managers. Unit Managers and Scanners must have the permission "Manage virtual scanner appliances".
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
action=create |
Required |
String |
Specify action to add new 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. |
|
name={string} |
Required |
String |
The friendly name. This name can’t already be assigned to an appliance in your account. It can be a maximum of 15 characters, spaces are not allowed. |
|
polling_interval={value} |
Optional |
Integer |
The polling interval, in seconds. A valid value is 60 to 3600 (we recommend 180 which is the default). This is the frequency that the virtual scanner will attempt to connect to our Cloud Security Platform. The appliance calls home to provide health updates/heartbeats to the platform, to get software updates from the platform, to learn if new scan jobs have been requested by users, and to upload scan results data to the platform, if applicable. |
|
asset_group_id={value} |
Required for Unit Managers and Scanners |
Integer |
The ID of an asset group the virtual scanner will be assigned to. |
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -X "POST"-d "action=create&echo_request=1&name=scanner1""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/appliance/appliance_create_output.dtd">
<APPLIANCE_CREATE_OUTPUT>
<RESPONSE>
<DATETIME>2018-05-02T09:26:01Z</DATETIME>
<ID>777</ID>
<NAME>scanner1</NAME>
<ACTIVATION CODE>ACTIVATION-CODE</ACTIVATION CODE>
<REMAINING_QVSA_LICENSES>4</REMAINING_QVSA_LICENSES>
</RESPONSE>
</APPLIANCE_CREATE_OUTPUT><platform API server>/api/2.0/fo/appliance/appliance_create_output.dtd