Update PC Option Profile
Click to view navigation pane


Update PC Option Profile

For API version information, refer to the API Version History section. 

V2.0|V3.0| V4.0

V2.0

POST/api/2.0/fo/subscription/option_profile/pc/?action=update

Update a PC option profile for compliance scans (using SCA or PC) 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.

Note: The update PC option profile 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=update

Required

 String

Specify action to update PC 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 option profile to update.

For the list of optional parameters, see input parameters for Create PC option profile.

Sample - Update PC Option ProfileSample - Update PC Option Profile

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST"action=update&title=pc-jp&id=51491401" "http://<qualys_base_url>/api/2.0/fo/subscription/option_profile/pc/"

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-10T11:10:36Z</DATETIME>
    <TEXT>Compliance Option profile successfully updated.</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>51491401</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Update for Database UDCSample - Update for Database UDC

API Request

curl -u "username:password" -H "X-Requested-With:curl" -H "Content-type: text/xml" -X POST -d "action=update&id=1709710&title=API-PC-OP-Oracle-custom-limit &scan_ports=targeted&oracle_db_udc_restriction=1&oracle_db_udc_lim it=100" "https://<qualys_base_url>/api/2.0/fo/subscription/option_profi le/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM 
"https://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
 <RESPONSE>
 <DATETIME>2019-05-20T06:45:00Z</DATETIME>
 <TEXT>Compliance Option profile successfully updated.</TEXT>
 <ITEM_LIST>
 <ITEM>
 <KEY>ID</KEY>
 <VALUE>1709710</VALUE>
 </ITEM>
 </ITEM_LIST>
 </RESPONSE>
</SIMPLE_RETURN>

DTD

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

V3.0

POST/api/3.0/fo/subscription/option_profile/pc/?action=update

Update a PC option profile for compliance scans (using SCA or PC) 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.

Note: The update PC option profile 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=update

Required

 String

Specify action to update PC 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 option profile to update.

For the list of optional parameters, see input parameters for Create PC option profile.

Sample - Update PC Option ProfileSample - Update PC Option Profile

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST"action=update&title=pc-jp&id=51491401" "http://<qualys_base_url>/api/3.0/fo/subscription/option_profile/pc/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "http://<qualys_base_url>/api/3.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-10T11:10:36Z</DATETIME>
    <TEXT>Compliance Option profile successfully updated.</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>51491401</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Update for Database UDCSample - Update for Database UDC

API Request

curl -u "username:password" -H "X-Requested-With:curl" -H "Content-type: text/xml" -X POST -d "action=update&id=1709710&title=API-PC-OP-Oracle-custom-limit &scan_ports=targeted&oracle_db_udc_restriction=1&oracle_db_udc_lim it=100" "https://<qualys_base_url>/api/3.0/fo/subscription/option_profi le/pc/"

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>2019-05-20T06:45:00Z</DATETIME>
 <TEXT>Compliance Option profile successfully updated.</TEXT>
 <ITEM_LIST>
 <ITEM>
 <KEY>ID</KEY>
 <VALUE>1709710</VALUE>
 </ITEM>
 </ITEM_LIST>
 </RESPONSE>
</SIMPLE_RETURN>

Sample - Update Option Profile using MySQL Template IDSample - Update Option Profile using MySQL Template ID

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d "action=update&title=mysql_auth_op_apiupdate&scan_ports=targeted&id=2642120&mysql_template_id=5129495&enable_auth_instance_discovery=1&auto_auth_types=MySQL" "https://
<qualys_base_url>/api/3.0/fo/subscription/option_profile/pc/"

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-15T06:49:15Z</DATETIME>
            <TEXT>Compliance Option profile successfully updated.</TEXT>
            <ITEM_LIST>
                <ITEM>
                    <KEY>ID</KEY>
                    <VALUE>2642120</VALUE>
                </ITEM>
            </ITEM_LIST>
        </RESPONSE>
    </SIMPLE_RETURN>

Sample - Update Option Profile using MySQL Template NameSample - Update Option Profile using MySQL Template Name

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d "action=update&title=mysql_auth_op_apiupdatqe&scan_ports=targeted&id=2642191&mysql_template_name=Mysql_template_api&enable_auth_instance_discovery=1&auto_auth_types=MySQL" "https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/pc/"

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-15T12:19:05Z</DATETIME>
            <TEXT>Compliance Option profile successfully updated.</TEXT>
            <ITEM_LIST>
                <ITEM>
                    <KEY>ID</KEY>
                    <VALUE>2642191</VALUE>
                </ITEM>
            </ITEM_LIST>
        </RESPONSE>
    </SIMPLE_RETURN>

DTD

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

V4.0

POST/api/4.0/fo/subscription/option_profile/pc/?action=update

Update a PC option profile for compliance scans (using SCA or PC) 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.

Note: The update PC option profile 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=update

Required

 String

Specify action to update PC 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 option profile to update.
clean_scan_data_on_dead_ho
sts{0|1}
 Optional Integer Use this parameter to indicate whether you would like to remove compliance scan data associated with dead hosts. Enter 1 if you wish to remove the compliance data or 0 if you do not wish to remove it.
host_not_found_alive_times{value}
 Optional Integer Enter the number of compliance scans to wait before removing compliance data associated with dead hosts. The valid range to set a number of compliance scans to wait before removing data is 1 to 99.

For the list of optional parameters, see input parameters for Create PC option profile.

Sample - Update PC Option ProfileSample - Update PC Option Profile

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST"action=update&title=pc-jp&id=51491401" "http://<qualys_base_url>/api/4.0/fo/subscription/option_profile/pc/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "http://<qualys_base_url>/api/4.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-10T11:10:36Z</DATETIME>
    <TEXT>Compliance Option profile successfully updated.</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>ID</KEY>
        <VALUE>51491401</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Update for Database UDCSample - Update for Database UDC

API Request

curl -u "username:password" -H "X-Requested-With:curl" -H "Content-type: text/xml" -X POST -d "action=update&id=1709710&title=API-PC-OP-Oracle-custom-limit &scan_ports=targeted&oracle_db_udc_restriction=1&oracle_db_udc_lim it=100" "https://<qualys_base_url>/api/4.0/fo/subscription/option_profi le/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM 
"https://<qualys_base_url>/api/4.0/simple_return.dtd">
<SIMPLE_RETURN>
 <RESPONSE>
 <DATETIME>2019-05-20T06:45:00Z</DATETIME>
 <TEXT>Compliance Option profile successfully updated.</TEXT>
 <ITEM_LIST>
 <ITEM>
 <KEY>ID</KEY>
 <VALUE>1709710</VALUE>
 </ITEM>
 </ITEM_LIST>
 </RESPONSE>
</SIMPLE_RETURN>

Sample - Update Option Profile using MySQL Template IDSample - Update Option Profile using MySQL Template ID

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d "action=update&title=mysql_auth_op_apiupdate&scan_ports=targeted&id=2642120&mysql_template_id=5129495&enable_auth_instance_discovery=1&auto_auth_types=MySQL" "https://
<qualys_base_url>/api/4.0/fo/subscription/option_profile/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM https://
<qualys_base_url>/api/4.0/simple_return.dtd>
    <SIMPLE_RETURN>
        <RESPONSE>
            <DATETIME>2024-07-15T06:49:15Z</DATETIME>
            <TEXT>Compliance Option profile successfully updated.</TEXT>
            <ITEM_LIST>
                <ITEM>
                    <KEY>ID</KEY>
                    <VALUE>2642120</VALUE>
                </ITEM>
            </ITEM_LIST>
        </RESPONSE>
    </SIMPLE_RETURN>

Sample - Update Option Profile using MySQL Template NameSample - Update Option Profile using MySQL Template Name

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "Username:Password" -d "action=update&title=mysql_auth_op_apiupdatqe&scan_ports=targeted&id=2642191&mysql_template_name=Mysql_template_api&enable_auth_instance_discovery=1&auto_auth_types=MySQL" "https://<qualys_base_url>/api/4.0/fo/subscription/option_profile/pc/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM https://
<qualys_base_url>/api/4.0/simple_return.dtd>
    <SIMPLE_RETURN>
        <RESPONSE>
            <DATETIME>2024-07-15T12:19:05Z</DATETIME>
            <TEXT>Compliance Option profile successfully updated.</TEXT>
            <ITEM_LIST>
                <ITEM>
                    <KEY>ID</KEY>
                    <VALUE>2642191</VALUE>
                </ITEM>
            </ITEM_LIST>
        </RESPONSE>
    </SIMPLE_RETURN>

DTD

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

API Version History

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/pc/?action=update To be deprecated February 2025

/api/3.0/fo/subscription/option_profile/pc/?action=update

 To be deprecated

February 2025

/api/4.0/fo/subscription/option_profile/pc/?action=update

 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.