List PC Option Profiles

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/subscription/option_profile/pc/?action=list

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 ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=list

Required

String 

Specify action to list the PC option profiles.

echo_request={0|1}

Optional

Integer 

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

{parameters}

Optional

String 

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 ProfilesSample - List PC Option Profiles

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET"action=list" "http://<qualys_base_url>/api/2.0/fo/subscription/option_profile/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM "http://<qualys_base_url>/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>
...

Sample - List Option Profile for Database UDCsSample - List Option Profile for Database UDCs

List the database preference key setting and it's corresponding value in Option Profile for MS SQL, Oracle, Sybase, PostgreSQL/Pivotal Greenplum, SAP IQ, and IBM DB2.

API Request

curl -u "username:password" -H "X-Requested-With:curl" -H "Content-type: text/xml" -X -d "action=list&id=1710150" "https://<qualys_base_url>/api/2.0/fo/subscription/option_profi le/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM 
"https://<qualys_base_url>/api/2.0/fo/subscription/option_profi
le/option_profile_info.dtd">
<OPTION_PROFILES>
 <OPTION_PROFILE>
 <BASIC_INFO>
 <ID>1710150</ID>
 ...
 </SCAN_BY_POLICY>
 </SCAN_RESTRICTION>
 <DATABASE_PREFERENCE_KEY>
 <MSSQL>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>250</DB_UDC_LIMIT>
 </MSSQL>
 <ORACLE>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>10</DB_UDC_LIMIT>
 </ORACLE>
 <SYBASE>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>60</DB_UDC_LIMIT>
 </SYBASE>
 <POSTGRESQL>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>2500</DB_UDC_LIMIT>
 </POSTGRESQL>
 <DB2>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>300</DB_UDC_LIMIT>
 </DB2> 
 </DATABASE_PREFERENCE_KEY>
 <FILE_INTEGRITY_MONITORING>
    <AUTO_UPDATE_EXPECTED_VALUE>0</AUTO_UPDATE_EXPECTED_VALUE>
</FILE_INTEGRITY_MONITORING>
</SCAN>
...
</OPTION_PROFILES>

DTD

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

V3.0

GET POST/api/3.0/fo/subscription/option_profile/pc/?action=list

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 ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=list

Required

String 

Specify action to list the PC option profiles.

echo_request={0|1}

Optional

Integer 

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

{parameters}

Optional

String 

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 ProfilesSample - List PC Option Profiles

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET"action=list" "http://<qualys_base_url>/api/3.0/fo/subscription/option_profile/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM "http://<qualys_base_url>/api/3.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>
...

Sample - List Option Profile for Database UDCsSample - List Option Profile for Database UDCs

List the database preference key setting and it's corresponding value in Option Profile for MS SQL, Oracle, Sybase, PostgreSQL/Pivotal Greenplum, SAP IQ, and IBM DB2.

API Request

curl -u "username:password" -H "X-Requested-With:curl" -H "Content-type: text/xml" -X -d "action=list&id=1710150" "https://<qualys_base_url>/api/3.0/fo/subscription/option_profi le/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM 
"https://<qualys_base_url>/api/3.0/fo/subscription/option_profi
le/option_profile_info.dtd">
<OPTION_PROFILES>
 <OPTION_PROFILE>
 <BASIC_INFO>
 <ID>1710150</ID>
 ...
 </SCAN_BY_POLICY>
 </SCAN_RESTRICTION>
 <DATABASE_PREFERENCE_KEY>
 <MSSQL>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>250</DB_UDC_LIMIT>
 </MSSQL>
 <ORACLE>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>10</DB_UDC_LIMIT>
 </ORACLE>
 <SYBASE>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>60</DB_UDC_LIMIT>
 </SYBASE>
 <POSTGRESQL>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>2500</DB_UDC_LIMIT>
 </POSTGRESQL>
 <DB2>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>300</DB_UDC_LIMIT>
 </DB2> 
 </DATABASE_PREFERENCE_KEY>
 <FILE_INTEGRITY_MONITORING>
    <AUTO_UPDATE_EXPECTED_VALUE>0</AUTO_UPDATE_EXPECTED_VALUE>
</FILE_INTEGRITY_MONITORING>
</SCAN>
...
</OPTION_PROFILES>

Sample - List Option Profile for MySQL TemplateSample - List Option Profile for MySQL Template

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d "action=list&id=2642191" "https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/pc/" 

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM https://
<qualys_base_url>/api/3.0/fo/subscription/option_profile/option_profile_info.dtd>
    <OPTION_PROFILES>
        <OPTION_PROFILE>
            <BASIC_INFO>
                <ID>2642191</ID>
                <GROUP_NAME>
                    <![CDATA[mysql_auth_op_apiupdatqe]]>
                </GROUP_NAME>
                <GROUP_TYPE>compliance</GROUP_TYPE>
                <USER_ID>
                    <![CDATA[s m (username)]]>
                </USER_ID>
                <UNIT_ID>0</UNIT_ID>
                <SUBSCRIPTION_ID>316805</SUBSCRIPTION_ID>
                <IS_GLOBAL>0</IS_GLOBAL>
                <UPDATE_DATE>2024-07-15T12:19:03Z</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>15</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>
                <SYSTEM_AUTH_RECORD>
                    <ALLOW_AUTH_CREATION>
                        <AUTHENTICATION_TYPE_LIST>
                            <AUTHENTICATION_TYPE>MySQL</AUTHENTICATION_TYPE>
                        </AUTHENTICATION_TYPE_LIST>
                        <MYSQL_AUTHENTICATION_TEMPLATE>
                            <ID>5144731</ID>
                            <TITLE>Mysql_template_api</TITLE>
                        </MYSQL_AUTHENTICATION_TEMPLATE>
                    </ALLOW_AUTH_CREATION>
                </SYSTEM_AUTH_RECORD>
                <FILE_INTEGRITY_MONITORING>                    <AUTO_UPDATE_EXPECTED_VALUE>0</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>
            <INSTANCE_DATA_COLLECTION />
            <OS_BASED_INSTANCE_DISC_COLLECTION />
        </OPTION_PROFILE>
    </OPTION_PROFILES>

DTD

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

V4.0

GET POST /api/4.0/fo/subscription/option_profile/pc/?action=list

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 ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=list

Required

String 

Specify action to list the PC option profiles.

echo_request={0|1}

Optional

Integer 

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

{parameters}

Optional

String 

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 ProfilesSample - List PC Option Profiles

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET"action=list" "http://<qualys_base_url>/api/4.0/fo/subscription/option_profile/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM "http://<qualys_base_url>/api/4.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>
...

Sample - List Option Profile for Database UDCsSample - List Option Profile for Database UDCs

List the database preference key setting and it's corresponding value in Option Profile for MS SQL, Oracle, Sybase, PostgreSQL/Pivotal Greenplum, SAP IQ, and IBM DB2.

API Request

curl -u "username:password" -H "X-Requested-With:curl" -H "Content-type: text/xml" -X -d "action=list&id=1710150" "https://<qualys_base_url>/api/4.0/fo/subscription/option_profi le/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM 
"https://<qualys_base_url>/api/4.0/fo/subscription/option_profi
le/option_profile_info.dtd">
<OPTION_PROFILES>
 <OPTION_PROFILE>
 <BASIC_INFO>
 <ID>1710150</ID>
 ...
 </SCAN_BY_POLICY>
 </SCAN_RESTRICTION>
 <DATABASE_PREFERENCE_KEY>
 <MSSQL>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>250</DB_UDC_LIMIT>
 </MSSQL>
 <ORACLE>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>10</DB_UDC_LIMIT>
 </ORACLE>
 <SYBASE>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>60</DB_UDC_LIMIT>
 </SYBASE>
 <POSTGRESQL>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>2500</DB_UDC_LIMIT>
 </POSTGRESQL>
 <DB2>
 <DB_UDC_RESTRICTION>1</DB_UDC_RESTRICTION>
 <DB_UDC_LIMIT>300</DB_UDC_LIMIT>
 </DB2> 
 </DATABASE_PREFERENCE_KEY>
 <FILE_INTEGRITY_MONITORING>
    <AUTO_UPDATE_EXPECTED_VALUE>0</AUTO_UPDATE_EXPECTED_VALUE>
</FILE_INTEGRITY_MONITORING>
</SCAN>
...
</OPTION_PROFILES>

Sample - List Option Profile for MySQL TemplateSample - List Option Profile for MySQL Template

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d "action=list&id=2642191" "https://<qualys_base_url>/api/4.0/fo/subscription/option_profile/pc/" 

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM https://
<qualys_base_url>/api/4.0/fo/subscription/option_profile/option_profile_info.dtd>
    <OPTION_PROFILES>
        <OPTION_PROFILE>
            <BASIC_INFO>
                <ID>2642191</ID>
                <GROUP_NAME>
                    <![CDATA[mysql_auth_op_apiupdatqe]]>
                </GROUP_NAME>
                <GROUP_TYPE>compliance</GROUP_TYPE>
                <USER_ID>
                    <![CDATA[s m (username)]]>
                </USER_ID>
                <UNIT_ID>0</UNIT_ID>
                <SUBSCRIPTION_ID>316805</SUBSCRIPTION_ID>
                <IS_GLOBAL>0</IS_GLOBAL>
                <UPDATE_DATE>2024-07-15T12:19:03Z</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>15</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>
                <SYSTEM_AUTH_RECORD>
                    <ALLOW_AUTH_CREATION>
                        <AUTHENTICATION_TYPE_LIST>
                            <AUTHENTICATION_TYPE>MySQL</AUTHENTICATION_TYPE>
                        </AUTHENTICATION_TYPE_LIST>
                        <MYSQL_AUTHENTICATION_TEMPLATE>
                            <ID>5144731</ID>
                            <TITLE>Mysql_template_api</TITLE>
                        </MYSQL_AUTHENTICATION_TEMPLATE>
                    </ALLOW_AUTH_CREATION>
                </SYSTEM_AUTH_RECORD>
                <FILE_INTEGRITY_MONITORING>                    <AUTO_UPDATE_EXPECTED_VALUE>0</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>
            <INSTANCE_DATA_COLLECTION />
            <OS_BASED_INSTANCE_DISC_COLLECTION />
        </OPTION_PROFILE>
    </OPTION_PROFILES>

 

API Version History

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

API Version API Status Release Date
/api/2.0/fo/subscription/option_profile/pc/?action=list To be deprecated February 2025
/api/3.0/fo/subscription/option_profile/pc/?action=list To be deprecated February 2025
/api/4.0/fo/subscription/option_profile/pc/?action=list Active August 2024

 

 

 


 

 

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.