Create New Containerized Scanner

POST/api/2.0/fo/appliance/qcss/?action=create

Create a new containerized scanner appliance in your account.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action={create}

Required

String 

Specify action to create a new containerized 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 32 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 containerized 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.

Sample - Create Containerized ApplianceSample - Create Containerized Appliance

API Request

curl --location --request POST
'https://<qualys_base_url>/api/2.0/fo/appliance/qcss/?action=creat
e&echo_
request=1&name=QcssScannerApi1 ' \
--header 'X-Requested-With: abc' \
--header 'Authorization: Basic cXdlYl9ybTI6UWF0ZW1wMTIzIw=='

 

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE APPLIANCE_CREATE_OUTPUT SYSTEM
"https://
<qualys_base_url>/api/2.0/fo/appliance/appliance_create_output.d
td">
  <APPLIANCE_CREATE_OUTPUT>
    <REQUEST>
      <DATETIME>2024-03-27T10:53:48Z</DATETIME>
      <USER_LOGIN>qweb_rm2</USER_LOGIN>
      <RESOURCE>https://
        <qualys_base_url>/api/2.0/fo/appliance/qcss/
        </RESOURCE>
        <PARAM_LIST>
          <PARAM>
            <KEY>action</KEY>
            <VALUE>create</VALUE>
          </PARAM>
          <PARAM>
            <KEY>echo_request</KEY>
            <VALUE>1</VALUE>
          </PARAM>
          <PARAM>
            <KEY>name</KEY>
            <VALUE>QcssScannerApi1</VALUE>
          </PARAM>
        </PARAM_LIST>
      </REQUEST>
      <RESPONSE>
        <DATETIME>2024-03-27T10:53:48Z</DATETIME>
        <APPLIANCE>
          <ID>1227168</ID>
          <FRIENDLY_NAME>QcssScannerApi1</FRIENDLY_NAME>
          <ACTIVATION_CODE>11111111111111</ACTIVATION_CODE>
          <REMAINING_QVSA_LICENSES>983</REMAINING_QVSA_LICENSES>
        </APPLIANCE>
      </RESPONSE>
    </APPLIANCE_CREATE_OUTPUT>

DTD

<platform API server>/api/2.0/fo/appliance/qcss/?action=create


 

 

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.