Get Schedule Details

[GET] /qps/rest/3.0/get/was/wasscanschedule/<id>

View details for a scheduled scan on a web application which is in the user’s scope. Want to find a schedule ID to use as input? See Search schedules.

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

Input ParametersInput Parameters

The element “id” (integer) is required, where “id” identifies a schedule.

Click here for available operators

Sample - View schedule detailsSample - View schedule details

Let us view details for schedule with ID 714393.

API request

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

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>714393</id>
            <name>
                <![CDATA[Web schedVulnerability Scan - 2017-06-30]]>
            </name>
            <owner>
                <id>2473353</id>
                <username>username</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Smith]]>
                </lastName>
            </owner>
            <active>false</active>
            <multi>true</multi>
            <type>VULNERABILITY</type>
            <target>
                <tags>
                    <included>
                        <option>ALL</option>
                        <tagList>
                            <list>
                                <Tag>
                                    <id>12075819</id>
                                    <name>
                                        <![CDATA[New_tag]]>
                                    </name>
                                </Tag>
                                <Tag>
                                    <id>2685657</id>
                                    <name>
                                        <![CDATA[Business Units]]>
                                    </name>
                                </Tag>
                            </list>
                        </tagList>
                    </included>
                </tags>
                <scannerAppliance>
                    <type>EXTERNAL</type>
                </scannerAppliance>
                <cancelOption>DEFAULT</cancelOption>
                <authRecordOption>DEFAULT</authRecordOption>
                <profileOption>DEFAULT</profileOption>
                <scannerOption>DEFAULT</scannerOption>
                <randomizeScan>false</randomizeScan>
                <useDnsOverride>false</useDnsOverride>
            </target>
            <profile>
                <id>598333</id>
                <name>
                    <![CDATA[Initial WAS Options]]>
                </name>
            </profile>
            <scheduling>
                <startDate>2017-06-30T11:26:00Z</startDate>
                <timeZone>
                    <code>Asia/Colombo</code>
                    <offset>+05:30</offset>
                </timeZone>
                <occurrenceType>ONCE</occurrenceType>
            </scheduling>
            <notification>
                <active>false</active>
                <reschedule>false</reschedule>
                <delay>
                    <nb>1</nb>
                    <scale>DAY</scale>
                </delay>
                <message>
                    <![CDATA[A Qualys scan is scheduled to start soon.]]>
                </message>
            </notification>
            <launchedCount>0</launchedCount>
            <createdDate>2017-06-30T05:57:12Z</createdDate>
            <createdBy>
                <id>2473353</id>
                <username>username</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Smith]]>
                </lastName>
            </createdBy>
            <updatedDate>2017-07-01T05:56:02Z</updatedDate>
            <updatedBy>
                <id>2473353</id>
                <username>username</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Smith]]>
                </lastName>
            </updatedBy>
            <sendMail>true</sendMail>
            <sendOneMail>true</sendOneMail>
            <enableWAFAuth>false</enableWAFAuth>
        </WasScanSchedule>
    </data>
</ServiceResponse>      
    

Sample - View schedule details (progressive scan)Sample - View schedule details (progressive scan)

The progressiveScanning element will be included in the call response, if Progressive Scanning is enabled for the subscription.

API request

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

XML response

<?xml version="1.0" encoding=
<?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>8183</id>
            <name>
                <![CDATA[WASUI-3772 #3]]>
            </name>
...
            
            <progressiveScanning>ENABLED</progressiveScanning>
...      
    

XSD

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