/api/2.0/fo/compliance/exception/?action=update
[POST]
Update one or more exceptions. All the actions you take are logged in the exception history with your name and a time stamp for when the action took place. This API is supported using PC.
Permissions - Click here for permissions info
Parameter |
Description |
action=update |
(Required) |
echo_request={0|1} |
(Optional) Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
exception_numbers={value} |
(Required) Exception numbers you want to update. Multiple entries are comma separated. An exception number range is specified with a hyphen (for example, 50-55).. |
comments={value} |
(Required) User defined comments. |
reassign_to={value} |
(Optional) You can reassign exceptions to another user. Specify user ID of the user, who has access to the hosts that the exceptions apply to. |
reopen_on_evidence_change={0|1} |
(Optional) This applies only if the exception is approved. Reopen the exception if a future scan returns a value different than the current value and the control is still failing. |
status={Pending|Approved|Rejected} |
(Optional) Update the status of the exception request. A valid value is: Pending, Approved, and Rejected. Learn more |
end_date={date} |
(Optional) Set the end date by entering a future date in mm/dd/yyyy format. For a never ending exception, set the expiry date to 0. The end date is only relevant to Approved exceptions. |
API request
curl -u "USERNAME:PASSWD" -H "X-Requested-With: Curl" -X "POST" -d "action=update&exception_numbers=55&status=Approved&end_date=12/16/2015&comments=status change" "https://qualysapi.qualys.com/api/2.0/fo/compliance/exception/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/compliance/exception/exception_batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2018-01-07T11:24:42Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Updated</TEXT>
<NUMBER_SET>
<NUMBER>55</NUMBER>
</NUMBER_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
<platform API server>/api/2.0/fo/compliance/exception/exception_batch_return.dtd