Update Scan Schedule

POST/api/2.0/fo/schedule/scan/?action=update

Update scan schedule in the user's account.  

During an update request you must specify target_from=assets when fqdn is specified in the same request. This is true for vulnerability scans and CertView type vulnerability scans. When fqdn is not specified during an update request for a scheduled scan that already has fqdn defined, we will keep the existing value.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=update

Required

String 

Specify action to update 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.

id={value}

Required

Integer 

ID of schedule you want to update.

fqdn={value}

Optional

Integer 

(VM scan only) The target FQDN for a vulnerability scan. You must specify at least one target i.e. IPs, asset groups or FQDNs. Multiple values are comma separated.

{scan parameters}

 

 

Click here to view scan parameters

{scan schedule parameters}

 

 

Click here to view scan schedule parameters

Sample - Update Scan Schedule Pause After 15 MinutesSample - Update Scan Schedule Pause After 15 Minutes

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -X "POST" -d "action=update&id=146754&pause_after_hours=0&pause_after_mins=15&resume_in_days=5&resume_in_hours=5" "https://<qualys_base_url>/api/2.0/fo/schedule/scan/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-05-14T11:57:42Z</DATETIME>
    <TEXT>Edit scheduled Scan Completed successfully</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>146754</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

DTD

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


 

 

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.