Create an Exception

Creates a new vulnerability exception.

POST/csapi/v1.3/exception

Input ParametersInput Parameters

Parameter Mandatory/Optional Data Type Description
name Mandatory string Specify a name for the exception.
reason Mandatory string Specify the reason to create the exception.
explanation Mandatory string Enter explanation to support the reason for creating the exception.
scope Mandatory string Specify the scope: IMAGE or CONTAINER.
When the scope is IMAGE, the exception is automatically cascaded to containers spawned from the image.
listId Mandatory string Specify the ID of the list to be used.
exceptionType Mandatory string Specify the exception type. Currently, only VULNERABILITY is supported.
entityAssignmentRequest Mandatory string

Specify the UUID of the images to be assigned to the exception.

You can either specify the UUIDs directly using "idsToAdd" or specify a filter using "additionFilter".

If "idsToAdd" is specified, "additionFilter" is ignored.

startDate Mandatory string Specify the start date to enforce the exception.
endDate Mandatory string Specify the end date for the exception.

Sample: Create a New Vulnerability ExceptionSample: Create a New Vulnerability Exception

API Request

curl -X "POST"
"<qualys_base_url>/csapi/v1.3/exception"
-H "accept: application/json"
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"
-d "{
    "name": "VulException1",
    "reason": "RISK_ACCEPTED",
    "explanation": "Testing API",
    "scope": "IMAGE",
    "listId": "5e586467-af10-47b8-ab26-509ac3b823b2",
    "exceptionType": "VULNERABILITY",
    "entityAssignmentRequest": {
        "idsToAdd": [
            "9baf9f85-f3bf-3259-b8d5-3cd51967d34a",
            "b5373ff0-044d-3004-8368-88541ae64a75"
        ],
        "additionFilter": null
    },
    "startDate": "1687777225000",
    "endDate": "4102358400000"
}'

Response

{
    "exceptionId": "3f86db22-2a2e-4976-a947-07d575fb50d5"
}

 

 

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.