For API version information, refer to the API Version History section.
Export one option profile or all option profiles in the subscription to an XML file. Manager role is required.
Parameter |
Required/Optional |
Data Type |
Description |
---|---|---|---|
action=export |
Required |
String |
Specify action to export option profile. |
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
output_format={XML} |
Optional |
File |
XML format is supported. When unspecified, output format is XML. |
option_profile_id={value} |
Optional |
Integer |
By default all option profiles will be exported. Specify an option profile ID and we’ll export the option profile matching this ID only. |
option_profile_title={value} |
Optional |
String |
By default all option profiles will be exported. Specify a title and we’ll export the option profile matching this title only - exact match is required. |
option_profile_type={value} |
Optional |
String |
Option profile group name/type, e.g. user (for user defined), compliance (for compliance profile), pci (for PCI vulnerabilities profile). Note: “option_profile_type” parameter can be specified with “option_profile_id” or “option_profile_title” |
include_system_option_ |
Optional |
Integer |
When unspecified or set to 0, system option profiles are not included in the output. Specify 1 to include system option profiles in the output. |
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET "action=export" "https://<qualys_base_url>/api/2.0/fo/subscription/option_profi le/"
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>111186</ID>
<GROUP_NAME><![CDATA[OP-SCAN]]></GROUP_NAME>
<GROUP_TYPE>user</GROUP_TYPE>
<USER_ID><![CDATA[John Doe(john_doe)]]></USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>44</SUBSCRIPTION_ID>
<IS_DEFAULT>0</IS_DEFAULT>
<IS_GLOBAL>1</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>N/A</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<PORTS>
<TCP_PORTS>
<TCP_PORTS_TYPE>full</TCP_PORTS_TYPE>
<THREE_WAY_HANDSHAKE>1</THREE_WAY_HANDSHAKE>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_TYPE>none</UDP_PORTS_TYPE>
<UDP_PORTS_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>1-1024,8080,8181</ADDITIONAL_PORTS>
</UDP_PORTS_ADDITIONAL>
</UDP_PORTS>
<AUTHORITATIVE_OPTION>1</AUTHORITATIVE_OPTION>
</PORTS>
<SCAN_DEAD_HOSTS>1</SCAN_DEAD_HOSTS>
<CLOSE_VULNERABILITIES>
<HAS_CLOSE_VULNERABILITIES>1</HAS_CLOSE_VULNERABILITIES>
<HOST_NOT_FOUND_ALIVE>7</HOST_NOT_FOUND_ALIVE>
</CLOSE_VULNERABILITIES>
<PURGE_OLD_HOST_OS_CHANGED>1</PURGE_OLD_HOST_OS_CHANGED>
<PERFORMANCE>
<PARALLEL_SCALING>1</PARALLEL_SCALING>
<OVERALL_PERFORMANCE>Custom</OVERALL_PERFORMANCE>
<HOSTS_TO_SCAN>
<EXTERNAL_SCANNERS>30</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>48</SCANNER_APPLIANCES>
</HOSTS_TO_SCAN>
<PROCESSES_TO_RUN>
<TOTAL_PROCESSES>18</TOTAL_PROCESSES>
<HTTP_PROCESSES>18</HTTP_PROCESSES>
</PROCESSES_TO_RUN>
<PACKET_DELAY>Minimum</PACKET_DELAY>
<PORT_SCANNING_AND_HOST_DISCOVERY>Minimum</PORT_SCANNING_AND_HOST_
DISCOVERY>
</PERFORMANCE>
<LOAD_BALANCER_DETECTION>1</LOAD_BALANCER_DETECTION>
<PASSWORD_BRUTE_FORCING>
<SYSTEM>
<HAS_SYSTEM>1</HAS_SYSTEM>
<SYSTEM_LEVEL>Standard</SYSTEM_LEVEL>
</SYSTEM>
<CUSTOM_LIST>
<CUSTOM>
<ID>3001</ID>
<TITLE><![CDATA[123]]></TITLE>
<TYPE>FTP</TYPE>
<LOGIN_PASSWORD><![CDATA[L:temp,P:123123123]]></LOGIN_PASSWORD>
</CUSTOM>
</CUSTOM_LIST>
</PASSWORD_BRUTE_FORCING>
<VULNERABILITY_DETECTION>
<CUSTOM_LIST>
<CUSTOM>
<ID>2094</ID>
<TITLE><![CDATA[Option Profile: Qualys Top 20 Options]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>2095</ID>
<TITLE><![CDATA[Option Profile: 2008 SANS20
Options]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>2096</ID>
<TITLE><![CDATA[Scan Report Template: High Severity
Report]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>5230</ID>
<TITLE><![CDATA[118960]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>87936</ID>
<TITLE><![CDATA[Bash Shellshock Detection]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>87937</ID>
<TITLE><![CDATA[Heartbleed Detection]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>87938</ID>
<TITLE><![CDATA[Windows Authentication Results v.1]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>87939</ID>
<TITLE><![CDATA[Unix Authentication Results v.1]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>87940</ID>
<TITLE><![CDATA[Inventory Results v.1]]></TITLE>
</CUSTOM>
<CUSTOM>
<ID>87941</ID>
<TITLE><![CDATA[SSL Certificates]]></TITLE>
</CUSTOM>
</CUSTOM_LIST>
<DETECTION_INCLUDE>
<BASIC_HOST_INFO_CHECKS>1</BASIC_HOST_INFO_CHECKS>
<OVAL_CHECKS>1</OVAL_CHECKS>
</DETECTION_INCLUDE>
<DETECTION_EXCLUDE>
<CUSTOM_LIST>
<CUSTOM>
<ID>2099</ID>
<TITLE><![CDATA[DL]]></TITLE>
</CUSTOM>
</CUSTOM_LIST>
</DETECTION_EXCLUDE>
</VULNERABILITY_DETECTION>
<AUTHENTICATION><![CDATA[Windows,Unix,Oracle,Oracle
Listener,SNMP,VMware,DB2,HTTP,MySQL,Sybase]]></AUTHENTICATION>
<AUTHENTICATION_LEAST_PRIVILEGE><![CDATA[Unix]]></AUTHENTICATION_L
EAST_PRIVILEGE>
<ADDL_CERT_DETECTION>1</ADDL_CERT_DETECTION>
<DISSOLVABLE_AGENT>
<DISSOLVABLE_AGENT_ENABLE>1</DISSOLVABLE_AGENT_ENABLE>
<WINDOWS_SHARE_ENUMERATION_ENABLE>1</WINDOWS_SHARE_ENUMERATION_ENA
BLE>
</DISSOLVABLE_AGENT>
<LITE_OS_SCAN>1</LITE_OS_SCAN>
<CUSTOM_HTTP_HEADER>
<VALUE>AFCD</VALUE>
</CUSTOM_HTTP_HEADER>
<FILE_INTEGRITY_MONITORING>
<AUTO_UPDATE_EXPECTED_VALUE>1</AUTO_UPDATE_EXPECTED_VALUE>
</FILE_INTEGRITY_MONITORING>
<DO_NOT_OVERWRITE_OS>1</DO_NOT_OVERWRITE_OS>
<SYSTEM_AUTH_RECORD>
<INCLUDE_SYSTEM_AUTH>
<ON_DUPLICATE_USE_USER_AUTH>1</ON_DUPLICATE_USE_USER_AUTH>
</INCLUDE_SYSTEM_AUTH>
</SYSTEM_AUTH_RECORD>
</SCAN>
<MAP>
<BASIC_INFO_GATHERING_ON>netblockonly</BASIC_INFO_GATHERING_ON>
<TCP_PORTS>
<TCP_PORTS_STANDARD_SCAN>1</TCP_PORTS_STANDARD_SCAN>
<TCP_PORTS_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>1,2,3,80</ADDITIONAL_PORTS>
</TCP_PORTS_ADDITIONAL>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_STANDARD_SCAN>1</UDP_PORTS_STANDARD_SCAN>
<UDP_PORTS_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>4,5,6,8181</ADDITIONAL_PORTS>
</UDP_PORTS_ADDITIONAL>
</UDP_PORTS>
<MAP_OPTIONS>
<PERFORM_LIVE_HOST_SWEEP>1</PERFORM_LIVE_HOST_SWEEP>
<DISABLE_DNS_TRAFFIC>1</DISABLE_DNS_TRAFFIC>
</MAP_OPTIONS>
<MAP_PERFORMANCE>
<OVERALL_PERFORMANCE>Custom</OVERALL_PERFORMANCE>
<MAP_PARALLEL>
<EXTERNAL_SCANNERS>16</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>14</SCANNER_APPLIANCES>
<NETBLOCK_SIZE>64</NETBLOCK_SIZE>
</MAP_PARALLEL>
<PACKET_DELAY>Maximum</PACKET_DELAY>
</MAP_PERFORMANCE>
<MAP_AUTHENTICATION>VMware</MAP_AUTHENTICATION>
</MAP>
<ADDITIONAL>
<HOST_DISCOVERY>
<TCP_PORTS>
<STANDARD_SCAN>1</STANDARD_SCAN>
<TCP_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>1-6,1024</ADDITIONAL_PORTS>
</TCP_ADDITIONAL>
</TCP_PORTS>
<UDP_PORTS>
<STANDARD_SCAN>1</STANDARD_SCAN>
</UDP_PORTS>
<ICMP>1</ICMP>
</HOST_DISCOVERY>
<BLOCK_RESOURCES>
<WATCHGUARD_DEFAULT_BLOCKED_PORTS>1</WATCHGUARD_DEFAULT_BLOCKED_PO
RTS>
<ALL_REGISTERED_IPS>1</ALL_REGISTERED_IPS>
</BLOCK_RESOURCES>
<PACKET_OPTIONS>
<IGNORE_FIREWALL_GENERATED_TCP_RST>1</IGNORE_FIREWALL_GENERATED_TC
P_RST>
<IGNORE_ALL_TCP_RST>1</IGNORE_ALL_TCP_RST>
<IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>1</IGNORE_FIREWALL_GENERATE
D_TCP_SYN_ACK>
<NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>1</NOT_SEND_TCP
_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>
</PACKET_OPTIONS>
</ADDITIONAL>
</OPTION_PROFILE>
</OPTION_PROFILES>
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl"-X GET "action=export&option_profile_title=OP-COMP&option_profile_id=111235" "https://<qualys_base_url>/api/2.0/fo/subscription/option_profile/"
XML Output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM "https://<qualys_base_url>/api/2.0/fo/subscription/option_profile/option_profile_info.dtd">
<OPTION_PROFILES>
<OPTION_PROFILE>
<BASIC_INFO>
<ID>111235</ID>
<GROUP_NAME><![CDATA[OP-COMP]]></GROUP_NAME>
<GROUP_TYPE>compliance</GROUP_TYPE>
<USER_ID><![CDATA[John Doe (john_doe)]]></USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>44</SUBSCRIPTION_ID>
<IS_GLOBAL>0</IS_GLOBAL>
<UPDATE_DATE>N/A</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>5</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>Short</PACKET_DELAY>
<PORT_SCANNING_AND_HOST_DISCOVERY>Minimum</PORT_SCANNING_AND_HOST_DISCOVERY>
</PERFORMANCE>
<DISSOLVABLE_AGENT>
<DISSOLVABLE_AGENT_ENABLE>1</DISSOLVABLE_AGENT_ENABLE>
<PASSWORD_AUDITING_ENABLE>
<HAS_PASSWORD_AUDITING_ENABLE>1</HAS_PASSWORD_AUDITING_ENABLE>
<CUSTOM_PASSWORD_DICTIONARY>asdf</CUSTOM_PASSWORD_DICTIONARY>
</PASSWORD_AUDITING_ENABLE>
<WINDOWS_SHARE_ENUMERATION_ENABLE>1</WINDOWS_SHARE_ENUMERATION_ENABLE>
<WINDOWS_DIRECTORY_SEARCH_ENABLE>1</WINDOWS_DIRECTORY_SEARCH_ENABLE>
</DISSOLVABLE_AGENT>
<CONTROL_TYPES>
<FIM_CONTROLS_ENABLED>1</FIM_CONTROLS_ENABLED>
<CUSTOM_WMI_QUERY_CHECKS>1</CUSTOM_WMI_QUERY_CHECKS>
</CONTROL_TYPES>
<TEST_AUTHENTICATION>1</TEST_AUTHENTICATION>
<SYSTEM_AUTH_RECORD>
<INCLUDE_SYSTEM_AUTH>
<ON_DUPLICATE_USE_SYSTEM_AUTH>1</ON_DUPLICATE_USE_SYSTEM_AUTH>
</INCLUDE_SYSTEM_AUTH>
</SYSTEM_AUTH_RECORD>
</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>
<BLOCK_RESOURCES>
<WATCHGUARD_DEFAULT_BLOCKED_PORTS>1</WATCHGUARD_DEFAULT_BLOCKED_PORTS>
<ALL_REGISTERED_IPS>1</ALL_REGISTERED_IPS>
</BLOCK_RESOURCES>
<PACKET_OPTIONS>
<IGNORE_FIREWALL_GENERATED_TCP_RST>1</IGNORE_FIREWALL_GENERATED_TCP_RST>
<IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>1</IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>
<NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>1</NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>
</PACKET_OPTIONS>
</ADDITIONAL>
</OPTION_PROFILE>
</OPTION_PROFILES>
API Request
curl --location '<qualys_base_url>/api/2.0/fo/subscription/option_profile/?action=export&option_profile_title=VM_API_Option_profile_01' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'X-Requested-With: curl demo2' \--header 'Accept: */*' \--header 'Content-Length: 0' \--header 'Authorization: Basic encoded username:password string'
XML Output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM "<qualys_base_url>/api/2.0/fo/subscription/option_profile/option_profile_info.dtd">
<OPTION_PROFILES>
<OPTION_PROFILE>
<BASIC_INFO>
<ID>2445050</ID>
<GROUP_NAME>
<![CDATA[VM_API_Option_profile_01]]>
</GROUP_NAME>
<GROUP_TYPE>user</GROUP_TYPE>
<USER_ID>
<![CDATA[Automation Test (scan_at)]]>
</USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>590924</SUBSCRIPTION_ID>
<IS_DEFAULT>0</IS_DEFAULT>
<IS_GLOBAL>0</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>2023-08-31T09:34:28Z</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<PORTS>
<TCP_PORTS>
<TCP_PORTS_TYPE>none</TCP_PORTS_TYPE>
<THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_TYPE>none</UDP_PORTS_TYPE>
</UDP_PORTS>
<AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION>
</PORTS>
<SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS>
<PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED>
<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>
<HOST_CGI_CHECKS>0</HOST_CGI_CHECKS>
<MAX_TARGETS_PER_SLICE>0</MAX_TARGETS_PER_SLICE>
<CONF_SCAN_LIMITED_CONNECTIVITY>0</CONF_SCAN_LIMITED_CONNECTIVITY>
<SKIP_PRE_SCANNING>0</SKIP_PRE_SCANNING>
</PERFORMANCE>
<LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION>
<VULNERABILITY_DETECTION>
<COMPLETE>
<![CDATA[complete]]>
</COMPLETE>
<DETECTION_INCLUDE>
<BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS>
<OVAL_CHECKS>0</OVAL_CHECKS>
<QRDI_CHECKS>0</QRDI_CHECKS>
</DETECTION_INCLUDE>
</VULNERABILITY_DETECTION>
<ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION>
<PERFORM_PARTIAL_SSL_TLS_AUDITING>1</PERFORM_PARTIAL_SSL_TLS_AUDITING>
</SCAN>
<MAP>
<BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON>
<MAP_OPTIONS>
<PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP>
<DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC>
</MAP_OPTIONS>
<MAP_PERFORMANCE>
<OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE>
<MAP_PARALLEL>
<EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>8</SCANNER_APPLIANCES>
<NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE>
</MAP_PARALLEL>
<PACKET_DELAY>Minimum</PACKET_DELAY>
</MAP_PERFORMANCE>
<MAP_AUTHENTICATION>none</MAP_AUTHENTICATION>
</MAP>
<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_ALL_TCP_RST>0</IGNORE_ALL_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>
</OPTION_PROFILES>
The option profile with PCI type in the user’s account get exported in XML format.
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET "action=export&option_profile_type=pci" "https://<qualys_base_url>/api/2.0/fo/subscription/option_profi le/"
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>111223</ID>
<GROUP_NAME><![CDATA[PCI-Example]]></GROUP_NAME>
<GROUP_TYPE>pci</GROUP_TYPE>
<USER_ID><![CDATA[John Doe (john_doe)]]></USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>44</SUBSCRIPTION_ID>
<IS_GLOBAL>1</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>N/A</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<SCAN_DEAD_HOSTS>1</SCAN_DEAD_HOSTS>
<CLOSE_VULNERABILITIES>
<HAS_CLOSE_VULNERABILITIES>1</HAS_CLOSE_VULNERABILITIES>
<HOST_NOT_FOUND_ALIVE>4</HOST_NOT_FOUND_ALIVE>
</CLOSE_VULNERABILITIES>
<PURGE_OLD_HOST_OS_CHANGED>1</PURGE_OLD_HOST_OS_CHANGED>
<PERFORMANCE>
<PARALLEL_SCALING>1</PARALLEL_SCALING>
<OVERALL_PERFORMANCE>Low</OVERALL_PERFORMANCE>
<HOSTS_TO_SCAN>
<EXTERNAL_SCANNERS>5</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>10</SCANNER_APPLIANCES>
</HOSTS_TO_SCAN>
<PROCESSES_TO_RUN>
<TOTAL_PROCESSES>4</TOTAL_PROCESSES>
<HTTP_PROCESSES>2</HTTP_PROCESSES>
</PROCESSES_TO_RUN>
<PACKET_DELAY>Long</PACKET_DELAY>
<PORT_SCANNING_AND_HOST_DISCOVERY>Minimum</PORT_SCANNING_AND_HOST_
DISCOVERY>
</PERFORMANCE>
</SCAN>
<ADDITIONAL>
<HOST_DISCOVERY>
<TCP_PORTS>
<STANDARD_SCAN>1</STANDARD_SCAN>
<TCP_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>1-6,1024</ADDITIONAL_PORTS>
</TCP_ADDITIONAL>
</TCP_PORTS>
</HOST_DISCOVERY>
</ADDITIONAL>
</OPTION_PROFILE>
</OPTION_PROFILES>
Export the Option Profile for MS SQL, Oracle, Sybase, PostgreSQL/Pivotal Greenplum, and IBM DB2 with database preference key setting and its corresponding value defined.
API Request
curl -u "username:password" -H "X-Requested-With:curl" -H "Content-type: text/xml" -X -d "action=export&option_profile_id=1710150" "https://<qualys_base_url>/api/2.0/fo/subscription/option_profi le/"
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>
<...
</POLICY>
</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>350</DB_UDC_LIMIT>
</DB2>
</DATABASE_PREFERENCE_KEY>
<FILE_INTEGRITY_MONITORING>
<AUTO_UPDATE_EXPECTED_VALUE>0</AUTO_UPDATE_EXPECTED_VALUE>
</FILE_INTEGRITY_MONITORING>
...
</OPTION_PROFILE>
</OPTION_PROFILES>
<platform API server>/api/2.0/fo/subscription/option_profile/option_profile_info.dtd
Export one option profile or all option profiles in the subscription to an XML file. Manager role is required.
Parameter |
Required/Optional |
Data Type |
Description |
---|---|---|---|
action=export |
Required |
String |
Specify action to export option profile. |
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
output_format={XML} |
Optional |
File |
XML format is supported. When unspecified, output format is XML. |
option_profile_id={value} |
Optional |
Integer |
By default all option profiles will be exported. Specify an option profile ID and we’ll export the option profile matching this ID only. |
option_profile_title={value} |
Optional |
String |
By default all option profiles will be exported. Specify a title and we’ll export the option profile matching this title only - exact match is required. |
option_profile_type={value} |
Optional |
String |
Option profile group name/type, e.g. user (for user defined), compliance (for compliance profile), pci (for PCI vulnerabilities profile). Note: “option_profile_type” parameter can be specified with “option_profile_id” or “option_profile_title” |
include_system_option_ |
Optional |
Integer |
When unspecified or set to 0, system option profiles are not included in the output. Specify 1 to include system option profiles in the output. |
scan_disconnected_esxi | Optional | Boolean | Launch the authenticated scan on ESXi hosts without creating VMware authorization records and VMware, vCenter mapping. 1 - If set to 1, the Disconnected ESXi checkbox is selected. 0 - If set to 0, the Disconnected ESXi checkbox is not selected |
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET "action=export" "https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/?action=export&option_profile_title=Option_profile_vCenter_scan_disconnected_esxi"
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>2633919</ID> <GROUP_NAME> <![CDATA[Option_profile_vCenter_scan_disconnected_esxi]]> </GROUP_NAME> <GROUP_TYPE>user</GROUP_TYPE> <USER_ID> <![CDATA[John Manager (agms_nb)]]> </USER_ID> <UNIT_ID>0</UNIT_ID> <SUBSCRIPTION_ID>194334</SUBSCRIPTION_ID> <IS_DEFAULT>0</IS_DEFAULT> <IS_GLOBAL>0</IS_GLOBAL> <IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE> <UPDATE_DATE>2024-07-01T09:55:01Z</UPDATE_DATE> </BASIC_INFO> <SCAN> <PORTS> <TCP_PORTS> <TCP_PORTS_TYPE>none</TCP_PORTS_TYPE> <THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE> </TCP_PORTS> <UDP_PORTS> <UDP_PORTS_TYPE>none</UDP_PORTS_TYPE> </UDP_PORTS> <AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION> </PORTS> <SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS> <PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED> <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_DISCOVER Y> </PERFORMANCE> <LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION> <VULNERABILITY_DETECTION> <COMPLETE> <![CDATA[complete]]> </COMPLETE> <DETECTION_INCLUDE> <BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS> <OVAL_CHECKS>0</OVAL_CHECKS> <QRDI_CHECKS>0</QRDI_CHECKS> </DETECTION_INCLUDE> </VULNERABILITY_DETECTION> <ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION> </SCAN> <MAP> <BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON> <MAP_OPTIONS> <PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP> <DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC> </MAP_OPTIONS> <MAP_PERFORMANCE> <OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE> <MAP_PARALLEL> <EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS> <SCANNER_APPLIANCES>8</SCANNER_APPLIANCES> <NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE> </MAP_PARALLEL> <PACKET_DELAY>Minimum</PACKET_DELAY> </MAP_PERFORMANCE> <MAP_AUTHENTICATION>vCenter</MAP_AUTHENTICATION> <DISCONNECTED_ESXI>1</DISCONNECTED_ESXI> </MAP> <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_ALL_TCP_RST>0</IGNORE_ALL_TCP_RST> <IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>0 </IGNORE_FIREWALL_GENERATED_TCP_S YN_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> </OPTION_PROFILES>
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl"-X GET "https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/?action=export&option_profile_id=2639622"
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>2639622</ID>
<GROUP_NAME>
<![CDATA[mob1]]>
</GROUP_NAME>
<GROUP_TYPE>user</GROUP_TYPE>
<USER_ID>
<![CDATA[John Manager (agms_jb)]]>
</USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>194334</SUBSCRIPTION_ID>
<IS_DEFAULT>0</IS_DEFAULT>
<IS_GLOBAL>0</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>2024-07-09T06:41:00Z</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<PORTS>
<TCP_PORTS>
<TCP_PORTS_TYPE>none</TCP_PORTS_TYPE>
<THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_TYPE>none</UDP_PORTS_TYPE>
</UDP_PORTS>
<AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION>
</PORTS>
<SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS>
<PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED>
<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>
<LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION>
<VULNERABILITY_DETECTION>
<COMPLETE>
<![CDATA[complete]]>
</COMPLETE>
<DETECTION_INCLUDE>
<BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS>
<OVAL_CHECKS>0</OVAL_CHECKS>
<QRDI_CHECKS>0</QRDI_CHECKS>
</DETECTION_INCLUDE>
</VULNERABILITY_DETECTION>
<ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION>
</SCAN>
<MAP>
<BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON>
<MAP_OPTIONS>
<PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP>
<DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC>
</MAP_OPTIONS>
<MAP_PERFORMANCE>
<OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE>
<MAP_PARALLEL>
<EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>8</SCANNER_APPLIANCES>
<NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE>
</MAP_PARALLEL>
<PACKET_DELAY>Minimum</PACKET_DELAY>
</MAP_PERFORMANCE>
<MAP_AUTHENTICATION>vCenter</MAP_AUTHENTICATION>
<DISCONNECTED_ESXI>1</DISCONNECTED_ESXI>
</MAP>
<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_ALL_TCP_RST>0</IGNORE_ALL_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>
</OPTION_PROFILES>
API Request
curl --location "https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/?action=export&option_profile_title=mob1"
\--header "Content-Type: application/x-www-form-urlencoded"
\--header "X-Requested-With: curl demo2"
\--header "Accept: */*" \--header "Content-Length: 0"
\--header "Authorization: Basic encoded username:password string"
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>2639622</ID>
<GROUP_NAME>
<![CDATA[mob1]]>
</GROUP_NAME>
<GROUP_TYPE>user</GROUP_TYPE>
<USER_ID>
<![CDATA[John Manager (agms_jb)]]>
</USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>194334</SUBSCRIPTION_ID>
<IS_DEFAULT>0</IS_DEFAULT>
<IS_GLOBAL>0</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>2024-07-09T06:41:00Z</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<PORTS>
<TCP_PORTS>
<TCP_PORTS_TYPE>none</TCP_PORTS_TYPE>
<THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_TYPE>none</UDP_PORTS_TYPE>
</UDP_PORTS>
<AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION>
</PORTS>
<SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS>
<PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED>
<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>
<LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION>
<VULNERABILITY_DETECTION>
<COMPLETE>
<![CDATA[complete]]>
</COMPLETE>
<DETECTION_INCLUDE>
<BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS>
<OVAL_CHECKS>0</OVAL_CHECKS>
<QRDI_CHECKS>0</QRDI_CHECKS>
</DETECTION_INCLUDE>
</VULNERABILITY_DETECTION>
<ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION>
</SCAN>
<MAP>
<BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON>
<MAP_OPTIONS>
<PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP>
<DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC>
</MAP_OPTIONS>
<MAP_PERFORMANCE>
<OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE>
<MAP_PARALLEL>
<EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>8</SCANNER_APPLIANCES>
<NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE>
</MAP_PARALLEL>
<PACKET_DELAY>Minimum</PACKET_DELAY>
</MAP_PERFORMANCE>
<MAP_AUTHENTICATION>vCenter</MAP_AUTHENTICATION>
<DISCONNECTED_ESXI>1</DISCONNECTED_ESXI>
</MAP>
<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_ALL_TCP_RST>0</IGNORE_ALL_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>
</OPTION_PROFILES>
<platform API server>/api/3.0/fo/subscription/option_profile/option_profile_info.dtd
Export one option profile or all option profiles in the subscription to an XML file. Manager role is required.
Parameter |
Required/Optional |
Data Type |
Description |
---|---|---|---|
action=export |
Required |
String |
Specify action to export option profile. |
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
output_format={XML} |
Optional |
File |
XML format is supported. When unspecified, output format is XML. |
option_profile_id={value} |
Optional |
Integer |
By default all option profiles will be exported. Specify an option profile ID and we’ll export the option profile matching this ID only. |
option_profile_title={value} |
Optional |
String |
By default all option profiles will be exported. Specify a title and we’ll export the option profile matching this title only - exact match is required. |
option_profile_type={value} |
Optional |
String |
Option profile group name/type, e.g. user (for user defined), compliance (for compliance profile), pci (for PCI vulnerabilities profile). Note: “option_profile_type” parameter can be specified with “option_profile_id” or “option_profile_title” |
include_system_option_ |
Optional |
Integer |
When unspecified or set to 0, system option profiles are not included in the output. Specify 1 to include system option profiles in the output. |
scan_disconnected_esxi | Optional | Boolean | Launch the authenticated scan on ESXi hosts without creating VMware authorization records and VMware, vCenter mapping. 1 - If set to 1, the Disconnected ESXi checkbox is selected. 0 - If set to 0, the Disconnected ESXi checkbox is not selected |
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET "action=export" "https://<qualys_base_url>/api/4.0/fo/subscription/option_profile/?action=export&option_profile_title=Option_profile_vCenter_scan_disconnected_esxi"
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>2633919</ID> <GROUP_NAME> <![CDATA[Option_profile_vCenter_scan_disconnected_esxi]]> </GROUP_NAME> <GROUP_TYPE>user</GROUP_TYPE> <USER_ID> <![CDATA[John Manager (agms_nb)]]> </USER_ID> <UNIT_ID>0</UNIT_ID> <SUBSCRIPTION_ID>194334</SUBSCRIPTION_ID> <IS_DEFAULT>0</IS_DEFAULT> <IS_GLOBAL>0</IS_GLOBAL> <IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE> <UPDATE_DATE>2024-07-01T09:55:01Z</UPDATE_DATE> </BASIC_INFO> <SCAN> <PORTS> <TCP_PORTS> <TCP_PORTS_TYPE>none</TCP_PORTS_TYPE> <THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE> </TCP_PORTS> <UDP_PORTS> <UDP_PORTS_TYPE>none</UDP_PORTS_TYPE> </UDP_PORTS> <AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION> </PORTS> <SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS> <PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED> <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_DISCOVER Y> </PERFORMANCE> <LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION> <VULNERABILITY_DETECTION> <COMPLETE> <![CDATA[complete]]> </COMPLETE> <DETECTION_INCLUDE> <BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS> <OVAL_CHECKS>0</OVAL_CHECKS> <QRDI_CHECKS>0</QRDI_CHECKS> </DETECTION_INCLUDE> </VULNERABILITY_DETECTION> <ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION> </SCAN> <MAP> <BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON> <MAP_OPTIONS> <PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP> <DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC> </MAP_OPTIONS> <MAP_PERFORMANCE> <OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE> <MAP_PARALLEL> <EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS> <SCANNER_APPLIANCES>8</SCANNER_APPLIANCES> <NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE> </MAP_PARALLEL> <PACKET_DELAY>Minimum</PACKET_DELAY> </MAP_PERFORMANCE> <MAP_AUTHENTICATION>vCenter</MAP_AUTHENTICATION> <DISCONNECTED_ESXI>1</DISCONNECTED_ESXI> </MAP> <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_ALL_TCP_RST>0</IGNORE_ALL_TCP_RST> <IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>0 </IGNORE_FIREWALL_GENERATED_TCP_S YN_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> </OPTION_PROFILES>
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl"-X GET "https://<qualys_base_url>/api/4.0/fo/subscription/option_profile/?action=export&option_profile_id=2639622"
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>2639622</ID>
<GROUP_NAME>
<![CDATA[mob1]]>
</GROUP_NAME>
<GROUP_TYPE>user</GROUP_TYPE>
<USER_ID>
<![CDATA[John Manager (agms_jb)]]>
</USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>194334</SUBSCRIPTION_ID>
<IS_DEFAULT>0</IS_DEFAULT>
<IS_GLOBAL>0</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>2024-07-09T06:41:00Z</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<PORTS>
<TCP_PORTS>
<TCP_PORTS_TYPE>none</TCP_PORTS_TYPE>
<THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_TYPE>none</UDP_PORTS_TYPE>
</UDP_PORTS>
<AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION>
</PORTS>
<SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS>
<PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED>
<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>
<LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION>
<VULNERABILITY_DETECTION>
<COMPLETE>
<![CDATA[complete]]>
</COMPLETE>
<DETECTION_INCLUDE>
<BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS>
<OVAL_CHECKS>0</OVAL_CHECKS>
<QRDI_CHECKS>0</QRDI_CHECKS>
</DETECTION_INCLUDE>
</VULNERABILITY_DETECTION>
<ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION>
</SCAN>
<MAP>
<BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON>
<MAP_OPTIONS>
<PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP>
<DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC>
</MAP_OPTIONS>
<MAP_PERFORMANCE>
<OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE>
<MAP_PARALLEL>
<EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>8</SCANNER_APPLIANCES>
<NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE>
</MAP_PARALLEL>
<PACKET_DELAY>Minimum</PACKET_DELAY>
</MAP_PERFORMANCE>
<MAP_AUTHENTICATION>vCenter</MAP_AUTHENTICATION>
<DISCONNECTED_ESXI>1</DISCONNECTED_ESXI>
</MAP>
<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_ALL_TCP_RST>0</IGNORE_ALL_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>
</OPTION_PROFILES>
API Request
curl --location "https://<qualys_base_url>/api/4.0/fo/subscription/option_profile/?action=export&option_profile_title=mob1"
\--header "Content-Type: application/x-www-form-urlencoded"
\--header "X-Requested-With: curl demo2"
\--header "Accept: */*" \--header "Content-Length: 0"
\--header "Authorization: Basic encoded username:password string"
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>2639622</ID>
<GROUP_NAME>
<![CDATA[mob1]]>
</GROUP_NAME>
<GROUP_TYPE>user</GROUP_TYPE>
<USER_ID>
<![CDATA[John Manager (agms_jb)]]>
</USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>194334</SUBSCRIPTION_ID>
<IS_DEFAULT>0</IS_DEFAULT>
<IS_GLOBAL>0</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>2024-07-09T06:41:00Z</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<PORTS>
<TCP_PORTS>
<TCP_PORTS_TYPE>none</TCP_PORTS_TYPE>
<THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_TYPE>none</UDP_PORTS_TYPE>
</UDP_PORTS>
<AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION>
</PORTS>
<SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS>
<PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED>
<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>
<LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION>
<VULNERABILITY_DETECTION>
<COMPLETE>
<![CDATA[complete]]>
</COMPLETE>
<DETECTION_INCLUDE>
<BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS>
<OVAL_CHECKS>0</OVAL_CHECKS>
<QRDI_CHECKS>0</QRDI_CHECKS>
</DETECTION_INCLUDE>
</VULNERABILITY_DETECTION>
<ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION>
</SCAN>
<MAP>
<BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON>
<MAP_OPTIONS>
<PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP>
<DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC>
</MAP_OPTIONS>
<MAP_PERFORMANCE>
<OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE>
<MAP_PARALLEL>
<EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>8</SCANNER_APPLIANCES>
<NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE>
</MAP_PARALLEL>
<PACKET_DELAY>Minimum</PACKET_DELAY>
</MAP_PERFORMANCE>
<MAP_AUTHENTICATION>vCenter</MAP_AUTHENTICATION>
<DISCONNECTED_ESXI>1</DISCONNECTED_ESXI>
</MAP>
<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_ALL_TCP_RST>0</IGNORE_ALL_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>
</OPTION_PROFILES>
<platform API server>/api/4.0/fo/subscription/option_profile/option_profile_info.dtd
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/subscription/option_profile/?action=export | To be deprecated | January 2025 |
/api/3.0/fo/subscription/option_profile/?action=export | To be deprecated |
February 2025 |
/api/4.0/fo/subscription/option_profile/?action=export | Active | August 2024 |
Was this topic helpful?