List PC option profiles

/api/2.0/fo/subscription/option_profile/pc/?action=list

[GET]  [POST]

List PC option profiles for compliance scans (using SCA or PC) in the user's account.

Note: The list PC option profiles API is available as part of one of the following subscription combinations only:
- PC and API add-on
- PC, SCA, and API add-on
- VMDR, SCA, and API add-on

Input Parameters

Parameter

Description

action=list

(Required)

echo_request={0|1}

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

{parameters}

(Optional) All option profiles are fetched if no parameters are given. To fetch a specific option profile, provide the “id” or “title” parameter with the option profile id or title of interest. Optionally, you can filter the results by using optional parameters

 

For a list of optional parameters, see input parameters for Create PCI option profile

Sample - List PC option profiles

API request

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

"action=list" "http://qualysapi.qualys.com/api/2.0/fo/subscription/option_profile/pc/"

XML output

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

<!DOCTYPE OPTION_PROFILES SYSTEM "http://qualysapi.qualys.com/api/2.0/fo/subscription/option_profile/option_profile_info.dtd">

<OPTION_PROFILES>

  <OPTION_PROFILE>

    <BASIC_INFO>

      <ID>19026</ID>

      <GROUP_NAME><![CDATA[Initial PC Options 2]]></GROUP_NAME>

      <GROUP_TYPE>compliance</GROUP_TYPE>

      <USER_ID><![CDATA[John Smith (jsmith_ap)]]></USER_ID>

      <UNIT_ID>0</UNIT_ID>

      <SUBSCRIPTION_ID>10421401</SUBSCRIPTION_ID>

      <IS_GLOBAL>1</IS_GLOBAL>

      <UPDATE_DATE>2018-04-10T11:10:36Z</UPDATE_DATE>

    </BASIC_INFO>

    <SCAN>

      <PORTS>

        <TARGETED_SCAN>1</TARGETED_SCAN>

      </PORTS>

      <PERFORMANCE>

        <PARALLEL_SCALING>0</PARALLEL_SCALING>

        <OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE>

        <HOSTS_TO_SCAN>

          <EXTERNAL_SCANNERS>10</EXTERNAL_SCANNERS>

          <SCANNER_APPLIANCES>30</SCANNER_APPLIANCES>

        </HOSTS_TO_SCAN>

        <PROCESSES_TO_RUN>

          <TOTAL_PROCESSES>10</TOTAL_PROCESSES>

          <HTTP_PROCESSES>10</HTTP_PROCESSES>

        </PROCESSES_TO_RUN>

        <PACKET_DELAY>Medium</PACKET_DELAY>

        <PORT_SCANNING_AND_HOST_DISCOVERY>Normal</PORT_SCANNING_AND_HOST_DISCOVERY>

      </PERFORMANCE>

      <DISSOLVABLE_AGENT>

        <DISSOLVABLE_AGENT_ENABLE>0</DISSOLVABLE_AGENT_ENABLE>

        <PASSWORD_AUDITING_ENABLE>

          <HAS_PASSWORD_AUDITING_ENABLE>0</HAS_PASSWORD_AUDITING_ENABLE>

        </PASSWORD_AUDITING_ENABLE>

        <WINDOWS_SHARE_ENUMERATION_ENABLE>0</WINDOWS_SHARE_ENUMERATION_ENABLE>

        <WINDOWS_DIRECTORY_SEARCH_ENABLE>0</WINDOWS_DIRECTORY_SEARCH_ENABLE>

      </DISSOLVABLE_AGENT>

      <FILE_INTEGRITY_MONITORING>

        <AUTO_UPDATE_EXPECTED_VALUE>1</AUTO_UPDATE_EXPECTED_VALUE>

      </FILE_INTEGRITY_MONITORING>

      <CONTROL_TYPES>

        <FIM_CONTROLS_ENABLED>0</FIM_CONTROLS_ENABLED>

        <CUSTOM_WMI_QUERY_CHECKS>0</CUSTOM_WMI_QUERY_CHECKS>

      </CONTROL_TYPES>

    </SCAN>

    <ADDITIONAL>

      <HOST_DISCOVERY>

        <TCP_PORTS>

          <STANDARD_SCAN>1</STANDARD_SCAN>

        </TCP_PORTS>

        <UDP_PORTS>

          <STANDARD_SCAN>1</STANDARD_SCAN>

        </UDP_PORTS>

        <ICMP>1</ICMP>

      </HOST_DISCOVERY>

      <PACKET_OPTIONS>

        <IGNORE_FIREWALL_GENERATED_TCP_RST>0</IGNORE_FIREWALL_GENERATED_TCP_RST>

        <IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>0</IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>

        <NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>0</NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>

      </PACKET_OPTIONS>

    </ADDITIONAL>

  </OPTION_PROFILE>

...

 

DTD

<platform API server>/api/2.0/fo/subscription/option_profile/option_profile_info.dtd