- Checkmarx Documentation
- Checkmarx SCA
- Checkmarx SCA (REST) API Documentation
- Checkmarx SCA (REST) APIs - APIs that will be deprecated
- Checkmarx SCA (REST) API - PUT Risk Reports UnIgnore Vulnerability
Checkmarx SCA (REST) API - PUT Risk Reports UnIgnore Vulnerability
Warning
The IgnoreVulnerability and UnignoreVulnerability APIs, which had been used for triaging SCA vulnerabilities, will be deprecated soon. They have been replaced by the new Management of Risk API, which supports applying any Checkmarx One state and adding comments. We recommend migrating to the new API soon.
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.
Error Response
Message: Message: |