Option Profile Export

/api/2.0/fo/subscription/option_profile/?action=export

[GET]

Export one option profile or all option profiles in the subscription to an XML file. Manager role is required.

Input Parameters

Parameter

Description

action=export

(Required)

echo_request={0|1}

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

output_format={XML}

(Optional) XML format is supported. When unspecified, output format is XML.

option_profile_id={value}

(Optional) 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) 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) 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_
profiles={0|1}

(Optional) 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.

 

Sample - Export Option Profile with specific title and ID

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://qualysapi.qualys.com/api/2.0/fo/subscription/option_profile/"

 

XML output

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

<!DOCTYPE OPTION_PROFILES SYSTEM "https://qualysapi.qualys.com/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>

 

 

DTD

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