Delete Schedule
Delete scheduled scans on web applications that are in the user’s scope.
Permissions required: User must have WAS module enabled. User account must have these permissions:
- Access Permission API Access
- Delete WAS Schedule
The scan target 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 - Delete the single scheduleSample - Delete the single schedule
Type your dropdown text here
API request:
curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @-
"<qualys_base_url>/qps/rest/3.0/delete/was/wasscanschedule/1846”
Note: “file.xml” contains the request POST data.
XML 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/was/wasscanschedule.xsd">
<responseCode>SUCCESS</responseCode>
<count>1</count>
<data>
<WasScanSchedule>
<id>1846</id>
</WasScanSchedule>
</data>
</ServiceResponse>
Sample - Delete schedules matching criteriaSample - Delete schedules matching criteria
API request:
curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @-
"<qualys_base_url>/qps/rest/3.0/delete/was/wasscanschedule/" < file.xml
Note: “file.xml” contains the request POST data.
Request POST data:
<ServiceRequest>
<filters>
<Criteria field="active" operator="EQUALS">false</Criteria>
<Criteria field="name" operator="CONTAINS">WEEKLY -</Criteria>
</filters>
</ServiceRequest>
XML response:
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="h<qualys_base_url>/qps/xsd/3.0/was/wasscanschedule.xsd">
<responseCode>SUCCESS</responseCode>
<count>2</count>
<data>
<WasScanSchedule>
<id>1747</id>
</WasScanSchedule>
<WasScanSchedule>
<id>1768</id>
</WasScanSchedule>
</data>
</ServiceResponse>
XSD
<platform API server>/qps/xsd/3.0/was/wasscanschedule.xsd