List Compliance Scan Schedules

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

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=list

Required

String 

Specify action to list compliance scan schedules.

echo_request={0|1}

Optional

Integer 

Specify 1 to echo the request’s input parameters (names and values) in the XML output. Otherwise parameters are not displayed in the output.

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.

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.

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/compliance?action=list"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE COMPLIANCE_SCHEDULE_SCAN_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/schedule/scan/compliance/compliance_schedule_scan_list_output.dtd">
<COMPLIANCE_SCHEDULE_SCAN_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2019-11-19T10:10:58Z</DATETIME>
        <COMPLIANCE_SCHEDULE_SCAN_LIST>
            <SCAN>
                <ID>57363</ID>
                <ACTIVE>1</ACTIVE>
                <TITLE>
                    <![CDATA[My Scan Schedule api6]]>
                </TITLE>
                <USER_LOGIN>quays_sp1</USER_LOGIN>
                <TARGET>
                    <![CDATA[10.10.10.185]]>
                </TARGET>
                <NETWORK_ID>
                    <![CDATA[0]]>
                </NETWORK_ID>
                <ISCANNER_NAME>
                    <![CDATA[pyscandsp]]>
                </ISCANNER_NAME>
                <ASSET_GROUP_TITLE_LIST>
                    <ASSET_GROUP_TITLE>
                        <![CDATA[policyred7]]>
                    </ASSET_GROUP_TITLE>
                </ASSET_GROUP_TITLE_LIST>
                <OPTION_PROFILE>
                    <TITLE>
                        <![CDATA[duplicate IO]]>
                    </TITLE>
                    <DEFAULT_FLAG>0</DEFAULT_FLAG>
                </OPTION_PROFILE>
                <SCHEDULE>
                    <DAILY frequency_days="5" />
                    <START_DATE_UTC>2019-11-19T22:00:00Z</START_DATE_UTC>
                    <START_HOUR>14</START_HOUR>
                    <START_MINUTE>0</START_MINUTE>
                    <NEXTLAUNCH_UTC>2019-11-19T22:00: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 />
            </SCAN>
        </COMPLIANCE_SCHEDULE_SCAN_LIST>
    </RESPONSE>
</COMPLIANCE_SCHEDULE_SCAN_LIST_OUTPUT>

DTD

<platform API server>/api/2.0/fo/schedule/scan/compliance/compliance_schedule_scan_list_output.dtd"


 

 

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.