Update Exceptions

[POST] /api/2.0/fo/compliance/exception/?action=update

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

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=update

Required

String

Specify action to update exceptions.

echo_request={0|1}

Optional

Integer 

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

exception_numbers={value}

Required

Integer 

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

String 

User defined comments.

reassign_to={value}

Optional

Integer 

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

Integer 

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

Boolean 

Update the status of the exception request. A valid value is: Pending, Approved, and Rejected. Learn more

end_date={date}

Optional

Integer 

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.

Sample - Update ExceptionSample - Update Exception

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://<qualys_base_url>/api/2.0/fo/compliance/exception/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "https://<qualys_base_url>/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>

DTD

<platform API server>/api/2.0/fo/compliance/exception/exception_batch_return.dtd


 

 

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.