Schedule Count

[GET] [POST] /qps/rest/3.0/count/was/wasscanschedule

Returns the total number of schedules in the user’s account. Input elements are optional and are used to filter the number of schedules included in the count.

Permissions required - User must have WAS module enabled. User account must have these permissions: Access Permission “API Access”. The output includes scan targets in the user's scope.

Input ParametersInput Parameters

These elements are optional and act as filters. When multiple elements are specified, parameters are combined using a logical AND. All dates must be entered in UTC date/time format. See Reference: WasScanSchedule for descriptions of these <WasScanSchedule> elements.

Click here for available operators

Parameter	Mandatory /Optional	Data Type	Description
id	Optional	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).
owner.id	Optional	integer	ID associated with the owner who created the schedule.
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.
webApp.tags (with operator="NONE")	Optional	keyword	Tags associated with the web application being scanned.
webApp.tags.id	Optional	integer	ID of the tag applied to the web application being scanned.
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.
active	Optional	boolean	Indicates whether the schedule is active or not. True indicates active schedule.

Sample - Get count of schedules in user's accountSample - Get count of schedules in user's account

Return the number (count) of all schedules in the user’s scope.

API request

curl -u "USERNAME:PASSWORD" <qualys_base_url>/qps/rest/3.0/count/was/wasscanschedule"

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>15</count>
</ServiceResponse>

Sample - Get count of schedules with a criteriaSample - Get count of schedules with a criteria

Return the number (count) of schedules for discovery scan type.

API request

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

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="type" operator="EQUALS">DISCOVERY</Criteria>
    </filters>
</ServiceRequest>

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>3</count>
</ServiceResponse>

Sample - Get count of schedules for web applications without tagsSample - Get count of schedules for web applications without tags

Return the number (count) of schedules for web application that are not tagged..

API request

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

Request POST data

<ServiceRequest>
	<filters>
		<Criteria field="webApp.tags" operator="NONE"></Criteria>
	</filters>
</ServiceRequest>

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>
</ServiceResponse>

Sample - Get count of schedules for web applications with tagsSample - Get count of schedules for web applications with tags

Return the number (count) of schedules for web applications that are tagged..

API request

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

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="webApp.tags.id" operator="EQUALS">1516928</Criteria>
        <Criteria field="webApp.tags.id" operator="EQUALS">1234567</Criteria>
    </filters>
</ServiceRequest>

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>
</ServiceResponse>

XSD

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