Update physical scanner

/api/2.0/fo/appliance/physical/?action=update

[POST]

This API is used to update physical scanner appliances in the user's account.

Permissions - Managers and Unit Managers can update physical scanner appliances.

Input Parameters

Parameter

Description

action=update

(Required)

echo_request={0|1}

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

name={string}

(Optional) 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) 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 physical 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.

set_vlans={value}

(Optional) Manage VLANs on scanner

set_routes={value}

(Optional) Manage static routes on scanner

set_tags= {value}

(Optional) Specify tag to be assigned to the scanner appliance. Both virtual and physical scanners can be tagged.

These parameters are mutually exclusive and cannot be specified in the same request: set_tags and add_tags, remove_tags.

add_tags= {value}

(Optional) Specify tag to be added to the existing list of tags assigned to the scanner. Multiple entries are comma separated.

These parameters are mutually exclusive and cannot be specified in the same request: set_tags and add_tags, remove_tags.

remove_tags= {value}

(Optional) Specify tag to be removed from the existing list of tags assigned to scanner. Multiple entries are comma separated.

These parameters are mutually exclusive and cannot be specified in the same request: set_tags and add_tags, remove_tags.

tag_set_by= {id|name}

(Optional) Specify "id" (the default) to select a tag set by providing tag IDs. Specify "name" to select a tag set by providing tag names.

comment={value}

(Optional) User-defined comments.

 

Sample - Update scanner comment

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -X "POST"

-d "action=update&id=5115&comment=Hello"

"https://qualysapi.qualys.com/api/2.0/fo/appliance/physical/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE SIMPLE_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/simple_return.dtd">

<SIMPLE_RETURN>

    <RESPONSE>

        <DATETIME>2018-5-01T00:12:29Z</DATETIME>

        <TEXT>Physical scanner updated successfully</TEXT>

        <ITEM_LIST>

            <ITEM>

                <KEY>ID</KEY>

                <VALUE>5115</VALUE>

            </ITEM>

        </ITEM_LIST>

    </RESPONSE>

</SIMPLE_RETURN>

Sample - Update scanner tags using "tag_set_by" and "add_tags"

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -X "POST" -d "action=update&id=5115&tag_set_by=id&add_tags=7691422" "https://qualysapi.qualys.com/api/2.0/fo/appliance/physical/"

 

Sample - Update scanner tags using "tag_set_by" and "remove_tags"

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -X "POST" -d "action=update&id=5115&tag_set_by=id&remove_tags=7691422" "https://qualysapi.qualys.com/api/2.0/fo/appliance/physical/"

DTD

<platform API server>/api/2.0/simple_return.dtd