Checkmarx SCA (REST) API - PUT Risk Reports UnIgnore Vulnerability
Warning
We are in the process of rolling out a comprehensive Management of Risks service which will enable users to manage the state and severity of risks, and add comments on a granular level. When this is implemented we will expose the public APIs that can be used for this service. At that point, the current APIs IgnoreVulnerability and UnignoreVulnerability will be deprecated. Please plan accordingly. For more info, feel free to contact your Technical Account Manager.
Description
Undoes the marking of a specific vulnerability as “Ignore” (for a specific package and Project).
Method
PUT
Workflow
If you identify a vulnerability that is marked as “Ignore” which you feel does currently pose a risk to your Project, then use this API to undo the “Ignore” marking.
URL
US Environment - https://api-sca.checkmarx.net/risk-management/risk-reports/UnIgnoreVulnerability
EU Environment - https://eu.api-sca.checkmarx.net/risk-management/risk-reports/UnIgnoreVulnerability
Curl Sample
curl -X PUT " https://api-sca.checkmarx.net/risk-management/risk-reports/UnIgnoreVulnerability" -H "accept: application/json" -d "{ "ProjectId": "1a73fc26-1234-4ecd-b2dd-d3aebfc1da21", "VulnerabilityId": "CVE-2021-25329", "PackageId": "Yarn-org.apache.tomcat.embed:tomcat-embed-core-8.5.23"}”
Media Type (header)
Authorization: Bearer <access_token>
Accept: application/json
Parameters
Body Parameters - Required
Parameter | Type | Enum | Description |
---|---|---|---|
ProjectId | string | - | The unique identifier of the Project. |
VulnerabilityId | string | - | The unique identifier of the vulnerability you would like to un-mark as “Ignore”. |
PackageId | string | - | The unique identifier of the package. |
Success Response
Code: 204 No Content
There is no body for the success response.