View a list of SCAP policies visible to the user. Optional input parameters support filtering the policy list output.
Maximum Policies per API Request
A maximum of 1,000 SCAP policy records can be processed per request. If the requested list identifies more than 1,000 policies, then the XML output includes the element and instructions for making another request for the next batch of policy records.
User Role | Permissions |
---|---|
Manager |
View all SCAP policies in subscription. View asset group information for all asset groups assigned to policies. |
Auditor |
View all SCAP policies in subscription. View asset group information for all asset groups assigned to policies. |
Unit Manager |
View all SCAP policies in subscription, when the “Manage compliance” permission is turned on in the user account settings. View asset group information for asset groups assigned to SCAP policies, when the user has permission to view these asset groups. |
Scanner |
View all SCAP policies in subscription, when the “Manage compliance” permission is turned on in the user account settings.. View asset group information for asset groups assigned to SCAP policies, when the user has permission to view these asset groups. |
Reader |
View all SCAP policies in subscription, when the “Manage compliance” permission is turned on in the user account settings.. View asset group information for asset groups assigned to SCAP policies, when the user has permission to view these asset groups. |
Parameter |
Required/Optional |
Data Type |
Description |
---|---|---|---|
action=list |
Required |
String |
Specify action to list SCAP policies. |
echo_request={0|1} |
Optional |
Integer |
Show (echo) the request’s input parameters (names and values) in the XML output. When unspecified, parameters are not included in the XML output. Specify 1 to view parameters in the XML output. |
details={Basic|All|None} |
Optional |
Boolean |
Show the requested amount of host information for each host. A valid value is: |
ids={value} |
Optional |
Integer |
Show only certain SCAP policy IDs/ranges. One or more policy IDs/ranges may be specified. Valid host IDs are required. Multiple entries are comma separated. A policy ID range is specified with a hyphen (for example, 190-400). |
id_min={value} |
Optional |
Integer |
Show only SCAP policies which have a minimum SCAP policy ID value. A valid SCAP policy ID is required. |
id_max={value} |
Optional |
Integer |
Show only SCAP policies which have a maximum SCAP policy ID value. A valid SCAP policy ID is required. |
XML Output
<!DOCTYPE POLICY_LIST_OUTPUT SYSTEM
"https://<qualys_base_url>/api/2.0/fo/compliance/fdcc_policy/fd
cc_policy_list_output.dtd">
<FDCC_POLICY_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2012-07-19T22:10:16Z</DATETIME>
<FDCC_POLICY_LIST>
<FDCC_POLICY>
<ID>10235</ID>
<TITLE><![CDATA[XP policy]]></TITLE>
<DESCRIPTION><![CDATA[This benchmark has been created to
assist IT professionals, in particular Windows XP system
administrators and information security personnel, in effectively
securing Windows XP Professional SP2 systems.]]></DESCRIPTION>
<BENCHMARK><![CDATA[FDCC-Windows-XP]]></BENCHMARK>
<BENCHMARK_PROFILE><![CDATA[federal_desktop_core_configuration_ver
sion_1.2.1.0]]></BENCHMARK_PROFILE>
<BENCHMARK_STATUS_DATE>2009-04-
08T00:00:00Z</BENCHMARK_STATUS_DATE>
<VERSION><![CDATA[v1.2.1.0]]></VERSION>
<TECHNOLOGY><![CDATA[Windows XP Desktop]]></TECHNOLOGY>
<NIST_PROVIDED><![CDATA[No]]></NIST_PROVIDED>
<CREATED>
<DATETIME>2012-07-18T23:03:35Z</DATETIME>
<BY>USERNAME</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2012-07-18T23:03:35Z</DATETIME>
<BY>USERNAME</BY>
</LAST_MODIFIED>
<ASSET_GROUP_LIST>
<ASSET_GROUP>
<ID>414242</ID>
<TITLE><![CDATA[10.10.10.40]]></TITLE>
</ASSET_GROUP>
<ASSET_GROUP>
<ID>414942</ID>
<TITLE><![CDATA[10 range]]></TITLE>
</ASSET_GROUP>
<ASSET_GROUP>
<ID>419582</ID>
<TITLE><![CDATA[10.10.10.29]]></TITLE>
</ASSET_GROUP>
<ASSET_GROUP>
<ID>419702</ID>
<TITLE><![CDATA[10.10.10.28-16-191]]></TITLE>
</ASSET_GROUP>
</ASSET_GROUP_LIST>
<FDCC_FILE_LIST>
<FDCC_FILE>
<FILE_NAME><![CDATA[fdcc-winxp-xccdf.xml]]></FILE_NAME>
<FILE_HASH><![CDATA[0c1a49c4ca47187995b543cfdcf35783]]></FILE_HASH
>
</FDCC_FILE>
<FDCC_FILE>
<FILE_NAME><![CDATA[fdcc-winxp-cpe-oval.xml]]></FILE_NAME>
<FILE_HASH><![CDATA[f397b9068b3881ef2a35c948326e6e4e]]></FILE_HASH
>
</FDCC_FILE>
<FDCC_FILE>
<FILE_NAME><![CDATA[fdcc-winxp-cpe-dictionary.xml]]></FILE_NAME>
<FILE_HASH><![CDATA[333b9b03961c58e65263bc86b4e0cdef]]></FILE_HASH
>
</FDCC_FILE>
<FDCC_FILE>
<FILE_NAME><![CDATA[fdcc-winxp-oval.xml]]></FILE_NAME>
<FILE_HASH><![CDATA[d1cf1f195bb58f295ca4b17dea2f99f0]]></FILE_HASH
>
</FDCC_FILE>
<FDCC_FILE>
<FILE_NAME><![CDATA[fdcc-winxp-patches.xml]]></FILE_NAME>
<FILE_HASH><![CDATA[4ae1b306344ef564c5da479a4a3d7f53]]></FILE_HASH
>
</FDCC_FILE>
</FDCC_FILE_LIST>
</FDCC_POLICY>
<FDCC_POLICY>
...
<FDCC_POLICY_LIST>
...
<FDCC_POLICY_LIST_OUTPUT>
<platform API server>/api/2.0/fo/compliance/fdcc_policy/fdcc_policy_list_output.dtd