Update Global Scan Configuration
Click to view navigation pane

Update Global Scan Configuration

POST/qps/rest/3.0/update/am/globalscanconfiguration

Once you enable cloud perimeter scan for your connector, you need to provide scan configuration for the cloud perimeter scan. You can either choose to provide custom scan configuration or specify global scan configuration settings to be used.

You can create global scan configuration to be used for the cloud perimeter scan. If the custom scan configuration is not specified for the cloud perimeter scan, then the global scan configuration is used.



Permissions required - Managers with full scope.

Input ParameterInput Parameter

Parameter

Mandatory

/Optional

Data Type

Description

optionProfileId

    

Specify the Option Profile Id. This Id is unique for every user. You can fetch the option profile Id using the List VM Option Profile API (/api/2.0/fo/subscription/option_profile/vm/?action=list). For more information on the how to fetch the option profile Id, refer to Qualys API (VM, PC) User Guide.

recurrence

    

Specify if the scan should be scheduled on DAILY or WEEKLY basis.

daysOfWeek

    

Specify the days when the scan should be scheduled. For example, SUN, MON, TUE, WED, THU, FRI, SAT.

Note: This field is applicable only if the recurrence field is set to WEEKLY.

scanPrefix

    

Specify a prefix to be appended to the scan name. Once the cloud perimeter scan is triggered from the Vulnerability Management application, the prefix is appended to the scan name. The scan name is in following format:

<prefix>-<connectorId>-<timestamp>

startDate

    

Specify the start date of scan in mm/dd/yyyy format.

startTime

    

Specify the start time of scan in HH:MM (24 hrs) format.

timezone

    

Specify the time zone for the cloud perimeter scan to be initiated.

Sample 1 - Update Global Scan ConfigurationSample 1 - Update Global Scan Configuration

API request

curl -n -u "USERNAME:PASSWORD" -H "content-type: text/xml" "<qualys_base_url>/r/qps/rest/3.0/update/am/globalscanconfiguration"

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <GlobalScanConfiguration>
            <scanPrefix>update global scan</scanPrefix>
            <optionProfileId>2</optionProfileId>
            <recurrence>WEEKLY</recurrence>
            <startDate>06/22/2022</startDate>
            <startTime>12:45</startTime>
            <daysOfWeek>
                <set>
                    <Day>SUN</Day>
                    <Day>TUE</Day>
                </set>
            </daysOfWeek>
            <timezone>Africa/Cairo</timezone>
        </GlobalScanConfiguration>
    </data>
</ServiceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/3.0/am/globalscanconfiguration.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <GlobalScanConfiguration>
            <scanPrefix>update global scan</scanPrefix>
            <optionProfileId>2</optionProfileId>
            <recurrence>WEEKLY</recurrence>
            <startDate>06/22/2022</startDate>
            <startTime>12:45</startTime>
            <daysOfWeek>
                <list>
                    <Day>SUN</Day>
                    <Day>TUE</Day>
                </list>
            </daysOfWeek>
            <timezone>Africa/Cairo</timezone>
        </GlobalScanConfiguration>
    </data>
</ServiceRequest>