list_scan_schedules
Click to view navigation pane


List Scan Schedules

For API version information, refer to the API Version History Section.

V2.0| V3.0| V4.0

V2.0

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

List scan schedules in the user's account.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action={value}

Required

 String 

Specify action to list scan schedules.

echo_request={0|1}

Optional

 Integer 

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

id={value}

Optional

 Integer 

The ID of the scan schedule you want to display.

active={0|1}

Optional

 Integer 

Specify 1 for active schedules only, or 0 for deactivated schedules only.

show_notifications={0|1}

Optional

 Integer 

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

scan_type=certview

Optional

 String 

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

show_cloud_details={0|1}

Optional

 Integer 

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

 Integer 

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

 String 

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

 String 

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

show_cloud_details={0|1}

Optional

 Integer 

 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 ScheduleSample - List a Scan Schedule

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""https://<qualys_base_url>/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://<qualys_base_url>/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 ScansSample - List a Schedule for Cloud Perimeter Scans

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""https://<qualys_base_url>/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://<qualys_base_url>/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

 

V3.0

GET POST api/3.0/fo/schedule/scan/?action=list

List scan schedules in the user's account.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action={value}

Required

 String 

Specify action to list scan schedules.

echo_request={0|1}

Optional

 Integer 

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

id={value}

Optional

 Integer 

The ID of the scan schedule you want to display.

active={0|1}

Optional

 Integer 

Specify 1 for active schedules only, or 0 for deactivated schedules only.

show_notifications={0|1}

Optional

 Integer 

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

scan_type=certview

Optional

 String 

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

show_cloud_details={0|1}

Optional

 Integer 

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

 Integer 

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

 String 

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

 String 

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

show_cloud_details={0|1}

Optional

 Integer 

 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 ScheduleSample - List a Scan Schedule

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""https://<qualys_base_url>/api/3.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://<qualys_base_url>/api/3.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 ScansSample - List a Schedule for Cloud Perimeter Scans

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""https://<qualys_base_url>/api/3.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://<qualys_base_url>/api/3.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>

Sample - List a schedule for Azure Internal ScansSample - List a schedule for Azure Internal Scans

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

API Request

curl --location '<qualys_base-url>/api/3.0/fo/schedule/scan/index.php?action=list&scan_type=internal&show_cloud_details=1&active=1&id=1396645' \
--header 'X-Requested-With: badsawewbu' \
--header 'User-Agent: agentname/1.0.0 (https://agentname.com)' \
--header 'Authorization: Encoded username:passwordstring' \
--header 'Accept: /' \
--header 'Host: qwb80-1.p14.eng.in03.qualys.com:43000' \
--header 'Connection: keep-alive'

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SCHEDULE_SCAN_LIST_OUTPUT SYSTEM 
"<qualys_base_url>/api/3.0/fo/schedule/scan/schedule_scan_list_output.dtd">
<SCHEDULE_SCAN_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2024-12-09T09:09:07Z</DATETIME>
        <SCHEDULE_SCAN_LIST>
            <SCAN>
                <ID>1396645</ID>
                <ACTIVE>1</ACTIVE>
                <TITLE>
                    <![CDATA[Connector id]]>
                </TITLE>
                <USER_LOGIN>vmsp_ag1</USER_LOGIN>
                <TARGET>
                    <![CDATA[]]>
                </TARGET>
                <NETWORK_ID>
                    <![CDATA[0]]>
                </NETWORK_ID>
                <ISCANNER_NAME>
                    <![CDATA[Azure_Internal_Scanner_New]]>
                </ISCANNER_NAME>
                <CLOUD_DETAILS>
                    <PROVIDER>AZURE</PROVIDER>
                    <CONNECTOR>
                        <ID>1642552</ID>
                        <UUID>ddc52e7b-bcef-42f4-9243-fb5747a23fc0</UUID>
                        <NAME>
                            <![CDATA[Azure VM Internal Scan]]>
                        </NAME>
                    </CONNECTOR>
                    <SCAN_TYPE>Cloud Internal</SCAN_TYPE>
                    <CLOUD_TARGET>
                        <PLATFORM>LOCATION</PLATFORM>
                        <REGION>
                            <UUID>080380ed-483e-45d7-8838-c5e637750e54</UUID>
                            <CODE>eastus</CODE>
                            <NAME>
                                <![CDATA[East US]]>
                            </NAME>
                        </REGION>
                    </CLOUD_TARGET>
                </CLOUD_DETAILS>
                <OPTION_PROFILE>
                    <TITLE>
                        <![CDATA[Initial Options]]>
                    </TITLE>
                    <DEFAULT_FLAG>1</DEFAULT_FLAG>
                </OPTION_PROFILE>
                <PROCESSING_PRIORITY>2 - Ultimate</PROCESSING_PRIORITY>
                <SCHEDULE>
                    <DAILY frequency_days="1" />
                    <START_DATE_UTC>2024-12-04T10:28:00Z</START_DATE_UTC>
                    <START_HOUR>15</START_HOUR>
                    <START_MINUTE>58</START_MINUTE>
                    <NEXTLAUNCH_UTC>2024-12-09T10:28:00</NEXTLAUNCH_UTC>
                    <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/3.0/fo/schedule/scan/schedule_scan_list_output.dtd

V4.0

GET POST api/4.0/fo/schedule/scan/?action=list

List scan schedules in the user's account.

Input ParametersInput Parameters

 

Parameter

Required/Optional

Data Type

Description

action={value}

Required

 String 

Specify action to list scan schedules.

echo_request={0|1}

Optional

 Integer 

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

id={value}

Optional

 Integer 

The ID of the scan schedule you want to display.

active={0|1}

Optional

 Integer 

Specify 1 for active schedules only, or 0 for deactivated schedules only.

show_notifications={0|1}

Optional

 Integer 

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

scan_type=certview

Optional

 String 

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

show_cloud_details={0|1}

Optional

 Integer 

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

 Integer 

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

 String 

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

 String 

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

show_cloud_details={0|1}

Optional

 Integer 

 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 Scan Schedule Sample - List Scan Schedule 

API Request

curl --location '<qualys_base_url>/api/4.0/fo/schedule/scan/index.php?action=list&id=1440922&show_cloud_details=1' \
--header 'X-Requested-With: e' \
--header 'Authorization: Basic c2Nhbl9hdDM6UUF0ZW1wMTIzIw=='

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SCHEDULE_SCAN_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/4.0/fo/schedule/scan/schedule_scan_list_output.dtd">
<SCHEDULE_SCAN_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2025-04-17T06:10:18Z</DATETIME>
        <SCHEDULE_SCAN_LIST>
            <SCAN>
                <ID>1440922</ID>
                <ACTIVE>1</ACTIVE>
                <TITLE>
                    <![CDATA[Azure Internal Scan now]]>
                </TITLE>
                <USER_LOGIN>scan_at3</USER_LOGIN>
                <TARGET>
                    <![CDATA[]]>
                </TARGET>
                <NETWORK_ID>
                    <![CDATA[0]]>
                </NETWORK_ID>
                <ISCANNER_NAME>
                    <![CDATA[Azure_Internal_Scanner]]>
                </ISCANNER_NAME>
                <CLOUD_DETAILS>
                    <PROVIDER>AZURE</PROVIDER>
                    <CONNECTOR>
                        <ID>1071626</ID>
                        <UUID>f4597cc6-4854-487a-85e3-15eb1595e40c</UUID>
                        <NAME>
                            <![CDATA[Azure_Connector_p01_scan_at]]>
                        </NAME>
                    </CONNECTOR>
                    <SCAN_TYPE>Cloud Internal</SCAN_TYPE>
                    <CLOUD_TARGET>
                        <PLATFORM>LOCATION</PLATFORM>
                        <REGION>
                            <UUID>080380ed-483e-45d7-8838-c5e637750e54</UUID>
                            <CODE>eastus</CODE>
                            <NAME>
                                <![CDATA[East US]]>
                            </NAME>
                        </REGION>
                    </CLOUD_TARGET>
                </CLOUD_DETAILS>
                <OPTION_PROFILE>
                    <TITLE>
                        <![CDATA[defaultOP_2025-04-11_00-49-54-751]]>
                    </TITLE>
                    <DEFAULT_FLAG>0</DEFAULT_FLAG>
                </OPTION_PROFILE>
                <PROCESSING_PRIORITY>0 - No Priority</PROCESSING_PRIORITY>
                <SCHEDULE>
                    <DAILY frequency_days="1" />
                    <START_DATE_UTC>2025-04-11T04:23:00Z</START_DATE_UTC>
                    <START_HOUR>9</START_HOUR>
                    <START_MINUTE>53</START_MINUTE>
                    <NEXTLAUNCH_UTC>2025-04-17T06:24:35</NEXTLAUNCH_UTC>
                    <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>
                    <MAX_OCCURRENCE>1</MAX_OCCURRENCE>
                    <LAUNCH_TYPE>now</LAUNCH_TYPE>
                </SCHEDULE>
            </SCAN>
        </SCHEDULE_SCAN_LIST>
    </RESPONSE>
</SCHEDULE_SCAN_LIST_OUTPUT>

 

The LAUNCH_TYPE tag indicates the type of scheduled scan - now or recurring - and is included in all Cloud Perimeter Scans and Azure Internal Scans.

DTD

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

API Version History

The following table depicts the information about the different versions of this API along with the status:

API Version API Status Release Date
/api/2.0/fo/schedule/scan/?action=list To be deprecated June 2025
/api/3.0/fo/schedule/scan/?action=list To be deprecated October 2025
/api/4.0/fo/schedule/scan/?action=list Active May 2025

 

 

Was this topic helpful?

success Thank you! We're glad to hear that this topic was useful.
success We appreciate your feedback. We'll work to make this topic better for you in the future.