Download Schedule

[POST] /qps/rest/3.0/download/was/wasscanschedule/<id>

[POST] /qps/rest/3.0/download/was/wasscanschedule/<filters>

Download scheduled scans on a web applications, which are in the user’s scope, to iCalendar format and then import them into your favorite calendar application so you can access your schedules on the go. You can import your schedules into several calendars, including Microsoft Outlook, Google Calendar, and Apple iCal.

Permissions required - User must have WAS module enabled. User account must have these permissions: Access Permission “API Access”. The schedule must be within the user’s scope.

Input ParametersInput Parameters

The “id” (integer) element and the data to be updated in the schedule are required where “id” identifies a schedule. When multiple elements are specified, parameters are combined using a logical AND. See Reference: WasScanSchedule for descriptions of all of the <WasScanSchedule> elements.

Click here for available operators

Parameter

Mandatory

/Optional

Data Type

Description

id

Mandatory

integer

The schedule ID. This element is assigned by the service and is required for a certain type of request.

name

Optional

text

The user-defined schedule name (maximum 256 characters).

createdDate

Optional

date

The date when the schedule was created in WAS, in UTC date/time format.

updatedDate

Optional

date

The date when the schedule was created in WAS, in UTC date/time format.

type

Optional

keyword

The scheduled scan type: VULNERABILITY or DISCOVERY.

webApp.name

Optional

text

The name of the web application being scanned.

webApp.id

Optional

integer

The ID of the web application being scanned.

owner.id

Optional

integer

ID is associated with the owner who created the schedule.

active

Optional

boolean

Indicates whether the schedule is active or not. True indicates an active schedule.

invalid

Optional

boolean

Indicates the schedule is invalid. The web application to which the schedule was applied is deleted and hence the schedule is invalid.

Sample - Download a single scheduleSample - Download a single schedule

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @-
"<qualys_base_url>/qps/rest/3.0/download/was/wasscanschedule/1846"
Note: “file.xml” contains the request POST data.      
    

XML response

BEGIN:VCALENDAR
PRODID:-//Qualys Inc//WAS Product//EN
VERSION:2.0
CALSCALE:GREGORIAN
METHOD:PUBLISH
BEGIN:VTIMEZONE
TZID:America/Boise
TZURL:http://tzurl.org/zoneinfo/America/Boise
X-LIC-LOCATION:America/Boise
BEGIN:DAYLIGHT
TZOFFSETFROM:-0700
TZOFFSETTO:-0600
TZNAME:MDT
DTSTART:20070311T020000
RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SU
END:DAYLIGHT
BEGIN:STANDARD
TZOFFSETFROM:-0600
TZOFFSETTO:-0700
TZNAME:MST
DTSTART:20071104T020000
RRULE:FREQ=YEARLY;BYMONTH=11;BYDAY=1SU
END:STANDARD
BEGIN:STANDARD
TZOFFSETFROM:-074449
TZOFFSETTO:-0800
TZNAME:PST
DTSTART:18831118T121511
END:STANDARD
BEGIN:DAYLIGHT
...
CREATED:20181128T204534Z
LAST-MODIFIED:20181128T210007Z
SEQUENCE:0
STATUS:CONFIRMED
TRANSP:TRANSPARENT
END:VEVENT
END:VCALENDAR     
    

XSD

<platform API server>/qps/xsd/3.0/was/wasscanschedule.xsd