Update Compliance Scan Schedule

POST/api/2.0/fo/schedule/scan/compliance/?action=update&id=<id>

Update compliance scan schedule in the user's account.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=update

Required

String 

Specify action to update compliance scan schedule.

echo_request={0|1}

Optional

Integer 

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

Scan Title

Optional

String 

scan_title

id={value}

Required

Integer 

ID of schedule you want to update.

Status

 Optional

Integer 

active=0|1

Compliance Profile

 Optional

Integer 

option_id or option_title

Scanner Appliance

 Optional

String/
Integer 

iscanner_id, iscanner_name, default_scanner, scanners_in_ag, scanners_in_network, scanners_in_tagset

Asset IPs/Groups

Optional 

Integer 

ip, asset_group_ids or asset_groups, exclude_ip_per_scan

Asset Tags

Optional 

Integer 

target_from=tags, use_ip_nt_range_tags, tag_include_selector, tag_exclude_selector, tag_set_by, tag_set_exclude, tag_set_include

Network

Optional 

Integer 

ip_network_id (when the Network Support feature is enabled)

Start Time

Optional

Integer 

Must be specified together:
set_start_time=1, start_date, start_hour, start_minute, time_zone_code, observe_dst

recurrence={value}

Optional

Integer 

The number of times the scan will be run before it is deactivated. For example, if you set recurrence=2, the scan schedule will be deactivated after it runs 2 times. By default no value is set. A valid value is an integer from 1 to 99.

Daily Scan

Optional 

Integer 

Must be specified together:
occurrence=daily, frequency_days

Weekly Scan

Optional 

Integer 

Must be specified together:
occurrence=weekly, frequency_weeks, weekdays

Monthly Scan

Optional

Integer 

Must be specified together: occurrence=monthly, frequency_months,
Nth day of month: day_of_month, Day in Nth week: day_of_week, week_of_month

End

Optional 

Integer 

end_after, end_after_mins

Pause and Resume

Optional 

Integer 

pause_after_hours, pause_after_mins, resume_in_days, resume_in_hours

Notifications

Optional 

Integer 

before_notify, before_notify_unit, before_notify_time, before_notify_message, after_notify, after_notify_message, recipient_group_ids

{scan parameters}

Optional 

Integer 

Click here to view scan parameters

{scan schedule parameters}

Optional 

Integer 

Click here to view scan schedule parameters

Sample - Update Compliance Scan ScheduleSample - Update Compliance Scan Schedule

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""http://<qualys_base_url>/api/2.0/fo/schedule/scan/compliance/?action=update&id=57360&option_id=39594" windows&ip=10.10.10.10&active=1&occurrence=weekly&start_hour=13&start_minute=30&time_zone_code=IN&frequency_weeks=1&weekdays=Sunday&end_after=0&end_after_mins=45&iscanner_name=pyscandsp&before_notify=1&before_notify_unit=hours&before_notify_time=20"windows&ip=10.10.10.10&active=1&occurrence=weekly&start_hour=13&start_minute=30&time_zone_code=IN&frequency_weeks=1&weekdays=Sunday&end_after=0&end_after_mins=45&iscanner_name=pyscandsp&before_notify=1&before_notify_unit=hours&before_notify_time=20"

XML Output

<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
    <RESPONSE>
        <DATETIME>2019-11-19T12:04:44Z</DATETIME>
        <TEXT>Edit scheduled Scan Completed successfully</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>ID</KEY>
                <VALUE>57360</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>

 

 

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.