List scan schedules

api/2.0/fo/schedule/scan/?action=list

[GET]  [POST]

List scan schedules in the user's account.

Input Parameters

Parameter

Description

action={value}

(Required)

echo_request={0|1}

(Optional) Specify 1 to view (echo) input parameters in the XML output. By default these are not included.

id={value}

(Optional) The ID of the scan schedule you want to display.

active={0|1}

(Optional) Specify 1 for active schedules only, or 0 for deactivated schedules only.

show_notifications={0|1}

(Optional) Specify 1 to include the notification settings for each schedule in the XML output.

scan_type=certview

(Optional) Launch a CertView type VM scan. This option will be supported when CertView GA is released and enabled for your account.

fqdn={value}

(Optional) (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.

show_cloud_details={0|1}

(Optional) Set to 1 to display the cloud details (Provider, Connector, Scan Type and Cloud Target) in the XML output. Otherwise the details are not displayed in the output.

client_id={value}

(Optional) Id assigned to the client (Consultant type subscription only). Parameter client_id or client_name may be specified for the same request.

client_name={value}

(Optional) Name of the client (Consultant type subscription only). Parameter client_id or client_name may be specified for the same request.

scan_type=perimeter

(Optional) List cloud perimeter scans only. This option will be supported for only Cloud Perimeter Scans.

show_cloud_details={0|1}

 (Optional) Set to 1 to display cloud details in the XML output. The cloud details will show scan type "Cloud Perimeter" for cloud perimeter scans.

Sample - List a scan schedule

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl"

"https://qualysapi.qualys.com/api/2.0/fo/schedule/scan/?action=list&id=160642&show_notifications=1"

 

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE SCHEDULE_SCAN_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/schedule/scan/schedule_scan_list_output.dtd">

<SCHEDULE_SCAN_LIST_OUTPUT>

  <RESPONSE>

    <DATETIME>2017-12-01T19:26:50Z</DATETIME>

    <SCHEDULE_SCAN_LIST>

      <SCAN>

        <ID>160642</ID>

        <ACTIVE>1</ACTIVE>

        <TITLE><![CDATA[My Daily Scan]]></TITLE>

        <USER_LOGIN>qualys_ps</USER_LOGIN>

        <TARGET><![CDATA[10.10.10.10-10.10.10.20]]></TARGET>

        <NETWORK_ID><![CDATA[0]]></NETWORK_ID>

        <ISCANNER_NAME><![CDATA[External Scanner]]></ISCANNER_NAME>

        <USER_ENTERED_IPS>

          <RANGE>

            <START>10.10.10.10</START>

            <END>10.10.10.20</END>

          </RANGE>

        </USER_ENTERED_IPS>

        <OPTION_PROFILE>

          <TITLE><![CDATA[Initial Options]]></TITLE>

          <DEFAULT_FLAG>1</DEFAULT_FLAG>

        </OPTION_PROFILE>

        <PROCESSING_PRIORITY>0 - No Priority</PROCESSING_PRIORITY>

        <SCHEDULE>

          <DAILY frequency_days="1" />

          <START_DATE_UTC>2017-11-30T00:30:00Z</START_DATE_UTC>

          <START_HOUR>16</START_HOUR>

          <START_MINUTE>30</START_MINUTE>

          <NEXTLAUNCH_UTC>2017-12-02T00:30:00</NEXTLAUNCH_UTC>

          <TIME_ZONE>

            <TIME_ZONE_CODE>US-CA</TIME_ZONE_CODE>

            <TIME_ZONE_DETAILS>(GMT-0800) United States: America/Los_Angeles</TIME_ZONE_DETAILS>

          </TIME_ZONE>

          <DST_SELECTED>1</DST_SELECTED>

        </SCHEDULE>

        <NOTIFICATIONS>

          <BEFORE_LAUNCH>

            <TIME>30</TIME>

            <UNIT><![CDATA[minutes]]></UNIT>

            <MESSAGE><![CDATA[This is my custom before scan email message.]]></MESSAGE>

          </BEFORE_LAUNCH>

          <AFTER_COMPLETE>

            <MESSAGE><![CDATA[This is my custom after scan email message.]]></MESSAGE>

          </AFTER_COMPLETE>

        </NOTIFICATIONS>

      </SCAN>

    </SCHEDULE_SCAN_LIST>

  </RESPONSE>

</SCHEDULE_SCAN_LIST_OUTPUT>

Sample - List a schedule for cloud perimeter scans

Users can now filter the schedule scan list to only show cloud perimeter scan jobs. Also, when you include cloud details in the output, we’ll show scan type "Cloud Perimeter".

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl"

"https://qualysapi.qualys.com/api/2.0/fo/schedule/scan/?action=list&id=1340788&scan_type=perimeter&show_cloud_details=1"

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE SCHEDULE_SCAN_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/schedule/scan/schedule_scan_list_output.dtd">

<SCHEDULE_SCAN_LIST_OUTPUT>

 <RESPONSE>

   <DATETIME>2018-04-12T12:57:03Z</DATETIME>

   <SCHEDULE_SCAN_LIST>

     <SCAN>

       <ID>1340788</ID>

       <ACTIVE></ACTIVE>

       <TITLE><![CDATA[My_External_Scan]]></TITLE>

       <USER_LOGIN>utwrx_mp</USER_LOGIN>

       <TARGET><![CDATA[Asset Tags Included]]></TARGET>

       <ISCANNER_NAME><![CDATA[External Scanner]]></ISCANNER_NAME>

       <EC2_INSTANCE>

         <CONNECTOR_UUID><![CDATA[8047abce-c3ac-42e0-ad49-be4181d22c84]]></CONNECTOR_UUID>

         <EC2_ENDPOINT><![CDATA[1507b6c1-07a7-4d88-acf2-8c6b63e749c4]]></EC2_ENDPOINT>

         <EC2_ONLY_CLASSIC><![CDATA[1]]></EC2_ONLY_CLASSIC>

       </EC2_INSTANCE>

       <CLOUD_DETAILS>

         <PROVIDER>AWS</PROVIDER>

         <CONNECTOR>

           <ID>37361</ID>

           <UUID>8047abce-c3ac-42e0-ad49-be4181d22c84</UUID>

           <NAME><![CDATA[EC2 Connector]]></NAME>

         </CONNECTOR>

         <SCAN_TYPE>Cloud Perimeter</SCAN_TYPE>

         <CLOUD_TARGET>

           <PLATFORM>Classic</PLATFORM>

           <REGION>

             <UUID>1507b6c1-07a7-4d88-acf2-8c6b63e749c4</UUID>

             <CODE>us-east-1</CODE>

             <NAME><![CDATA[US East (N. Virginia)]]></NAME>

           </REGION>

           <VPC_SCOPE>None</VPC_SCOPE>

         </CLOUD_TARGET>

       </CLOUD_DETAILS>

       <ASSET_TAGS>

         <TAG_INCLUDE_SELECTOR>any</TAG_INCLUDE_SELECTOR>

         <TAG_SET_INCLUDE><![CDATA[EC2_Targets]]></TAG_SET_INCLUDE>

         <TAG_EXCLUDE_SELECTOR>any</TAG_EXCLUDE_SELECTOR>

         <TAG_SET_EXCLUDE><![CDATA[EC2_Test]]></TAG_SET_EXCLUDE>

         <USE_IP_NT_RANGE_TAGS>0</USE_IP_NT_RANGE_TAGS>

       </ASSET_TAGS>

       <ELB_DNS>

         <DNS><![CDATA[abc.com]]></DNS>

         <DNS><![CDATA[abc123.com]]></DNS>

       </ELB_DNS>

       <OPTION_PROFILE>

         <TITLE><![CDATA[Initial Options]]></TITLE>

         <DEFAULT_FLAG>1</DEFAULT_FLAG>

       </OPTION_PROFILE>

       <PROCESSING_PRIORITY>0 - No Priority</PROCESSING_PRIORITY>

       <SCHEDULE>

         <DAILY frequency_days="364" />

         <START_DATE_UTC>2018-04-02T05:00:00Z</START_DATE_UTC>

         <START_HOUR>10</START_HOUR>

         <START_MINUTE>30</START_MINUTE>

         <TIME_ZONE>

           <TIME_ZONE_CODE>IN</TIME_ZONE_CODE>

           <TIME_ZONE_DETAILS>(GMT+0530) India: Asia/Calcutta</TIME_ZONE_DETAILS>

         </TIME_ZONE>

         <DST_SELECTED>0</DST_SELECTED>

       </SCHEDULE>

     </SCAN>

   </SCHEDULE_SCAN_LIST>

 </RESPONSE>

</SCHEDULE_SCAN_LIST_OUTPUT>

DTD

<platform API server>/api/2.0/fo/schedule/scan/schedule_scan_list_output.dtd