Suppress vulnerability

Request

Suppress vulnerability for component version(s). System administrator only has permission for global suppression, while Developer/Security contact have permission for project-specific suppression.
Note: For GLOBAL level suppression, providing suppression details is not necessary. These details are only required for PROJECT level suppression and will be ignored if provided in the GLOBAL scope.

The default value for the Suppression Scope will be considered GLOBAL if left empty.

Security

bearerAuth

Bodyapplication/jsonrequired

Input model to suppress vulnerability for component versions.

componentIdinteger, (int64), >= 1required

componentId

Example:1

versionIdsArray of integers, unique

versionIds

vulnerabilityNamestringrequired

vulnerabilityName

Example:"Vulnerability Name"

reasonstringrequired

reason

Example:"FALSE_POSITIVE|REMEDIATED|OTHER"

remarksstring, [ 0 .. 255 ] charactersrequired

remarks

Example:"Remarks to Suppress Vulnerability"

versionScopestringSPECIFIC_VERSIONS|ALL_CURRENT_VERSIONSrequired

versionScope

Example:"SPECIFIC_VERSIONS|ALL_CURRENT_VERSIONS"

suppressionScopestringGLOBAL|PROJECTrequired

suppressionScope

Example:"GLOBAL|PROJECT"

suppressionDetailsobject(SuppressionDetails)

suppressionDetails

curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/vulnerability/suppress \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "componentId": 1,
    "versionIds": [
      0
    ],
    "vulnerabilityName": "Vulnerability Name",
    "reason": "FALSE_POSITIVE|REMEDIATED|OTHER",
    "remarks": "Remarks to Suppress Vulnerability",
    "versionScope": "SPECIFIC_VERSIONS|ALL_CURRENT_VERSIONS",
    "suppressionScope": "GLOBAL|PROJECT",
    "suppressionDetails": {
      "projectId": 123,
      "state": "RESOLVED|RESOLVED_WITH_PEDIGREE|EXPLOITABLE|IN_TRIAGE|FALSE_POSITIVE",
      "justification": "CODE_NOT_PRESENT|CODE_NOT_REACHABLE|REQUIRES_CONFIGURATION|REQUIRES_DEPENDENCY|REQUIRES_ENVIRONMENT|PROTECTED_BY_COMPILER|PROTECTED_AT_RUNTIME|PROTECTED_AT_PERIMETER|PROTECTED_BY_MITIGATING_CONTROL",
      "response": "CAN_NOT_FIX|WILL_NOT_FIX|UPDATE|ROLLBACK|WORKAROUND_AVAILABLE"
    }
  }'

Responses

Bodyapplication/json