For API version information, refer to the API Version History section.
Update a VM option profile in the user's account.
Permissions - A Manager will be able to update option profiles in the subscription. A Unit Manager will be able to update option profiles owned by users in their business unit.
Parameter |
Required/Optional |
Data Type |
Description |
---|---|---|---|
action=update |
Required |
String |
Specify action to update the 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. |
id={value} |
Required |
Integer |
The ID of the option profile. |
Click here to view list of optional parameters
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST"action=update&title=33jj&id=25121""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 updated.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>25121</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
API Request
curl --location --request POST '<qualys_base_url>/api/2.0/fo/subscription/option_profile/vm/?enable_partial_ssl_tls_auditing=0&%20action=update&id=2437618&scan_tcp_ports=standard&scan_udp_ports=standard&vulnerability_detection=runtime'
\--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 SIMPLE_RETURN SYSTEM
"<<qualys_base_url>>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2023-08-31T10:04:24Z</DATETIME>
<TEXT>Option profile successfully updated.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>2437618</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
<platform API server>/api/2.0/simple_return.dtd
Update a VM option profile in the user's account.
Permissions - A Manager will be able to update option profiles in the subscription. A Unit Manager will be able to update option profiles owned by users in their business unit.
Parameter |
Required/Optional |
Data Type |
Description |
---|---|---|---|
action=update |
Required |
String |
Specify action to update the 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. |
id={value} |
Required |
Integer |
The ID of the option profile. |
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 |
Click here to view list of optional parameters
API Request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST"action=update&id=2633932&scan_tcp_ports=full&scan_udp_ports=full&vulnerability_detection=runtime&map_authentication=vCenter&scan_disconnected_esxi=1"
"https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/vm/"
XML Output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://
<qualys_base_url>/api/3.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2024-07-01T10:05:48Z</DATETIME>
<TEXT>Option profile successfully updated.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>2633932</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
API Request
curl --location --request POST "https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/vm/?enable_partial_ssl_tls_auditing=0&action=update&id=2639625&scan_tcp_ports=standard&scan_udp_ports=standard&vulnerability_detection=runtime" \--header "Content-Type: application/x-www-form-urlencoded" \--header "X-Requested-With: curl demo2" \--header "Accept: */*" \--header "Content-Length: 0" \--header "Authorization: Basic YWdtc19uYjpRYXRlbXAxMjMj"
XML Output
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE SIMPLE_RETURN SYSTEM " https://<qualys_base_url>/api/3.0/simple_return.dtd"> <SIMPLE_RETURN> <RESPONSE> <DATETIME>2024-07-09T07:19:13Z</DATETIME> <TEXT>Option profile successfully updated.</TEXT> <ITEM_LIST> <ITEM> <KEY>ID</KEY> <VALUE>2639625</VALUE> </ITEM> </ITEM_LIST> </RESPONSE> </SIMPLE_RETURN>
<platform API server>/api/3.0/simple_return.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=update | To be deprecated | January 2025 |
/api/3.0/fo/subscription/option_profile/?action=update | Active |
July 2024 |
Was this topic helpful?