Create VM Option Profile

POST/api/2.0/fo/subscription/option_profile/vm/?action=create

Create a VM option profile in the user's account.

Permissions - A Manager will be able to create option profiles in the subscription. A Unit Manager will be able to create option profiles for users in their business unit.

A Manager will be able to create, update, and delete option profiles in the subscription, and a Unit Manager will be able to create, update, and delete option profiles for users in their business unit.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=create

Required

String 

Specify action to create VM 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.

title={value}

Required

String 

The title of the option profile.

 

Click here to view list of optional parameters

Sample - Create VM Option ProfileSample - Create VM Option Profile

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST"action=create&title=99&global=1&scan_tcp_ports=full&scan_udp_ports=standard&&scan_overall_performance=normal&vulnerability_detection=complete&basic_information_gathering=all" "http://<qualys_base_url>/api/2.0/fo/subscription/option_profile/vm/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "http://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-26T06:40:03Z</DATETIME>
    <TEXT>Option profile successfully added.</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>32112</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Create VM Option Profile With SSL/TLS Auditing EnabledSample - Create VM Option Profile With SSL/TLS Auditing Enabled

API Request

curl --location --request POST '/api/2.0/fo/subscription/option_profile/vm/?%20a ction=c reate&title=VM_API_Option_profile_696969&scan_tcp_ports=none&scan_ udp_por ts=none&vulnerability_detection=complete&basic_information_gatheri ng=none &enable_partial_ssl_tls_auditing=1' \--header 'ContentType: application/x-www-form-urlencoded' \--header 'X-RequestedWith: curl demo2' \--header 'Accept: */*' \--header 'Content-Length: 0' \--header 'Authorization: Basic '

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM 
"<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
 <RESPONSE>
 <DATETIME>2023-08-31T10:05:16Z</DATETIME>
 <TEXT>Option profile successfully added.</TEXT>
 <ITEM_LIST>
 <ITEM>
 <KEY>ID</KEY>
 <VALUE>2445054</VALUE>
 </ITEM>
 </ITEM_LIST>
 </RESPONSE>
</SIMPLE_RETURN>

DTD

<platform API server>/api/2.0/simple_return.dtd