vulnerability

Get Suppressed Vulnerabilities

Get suppressed vulnerabilities based on componentId/vulnerabilityName or both; either of them is mandatory. Only the system administrator has the permission to do this operation.

Request

query Parameters

componentId	integer <int64> ID of the component. Example: componentId=1
vulnerabilityName	string Name of the vulnerability.
limit	integer <int32> Default: 25 Page size. Number of records to fetch per page. Example: limit=1 \| default: 25
offset	integer <int32> Default: 1 Page number. Index of the page to start with (starts from 1). Example: offset=1 \| default: 1

header Parameters

authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/vulnerability/suppress

Response samples

application/json

{"suppressId": 0,
"vulnerabilityId": 0,
"vulnerabilityName": "string",
"componentId": 0,
"componentName": "string",
"suppressedBy": "string",
"suppressedDate": "string",
"componentVersionIds": [0
]
}

Suppress Vulnerability

Suppress vulnerability for component version(s). Only system administrator has the permission to perform this operation.

Request

header Parameters

authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Input model to suppress vulnerability for component versions.

componentId required	integer <int64> >= 1 componentId
versionIds	Array of integers <int64> unique versionIds
vulnerabilityName required	string vulnerabilityName
reason required	stringFALSE_POSITIVE\|REMEDIATED\|OTHER reason
remarks required	string [ 0 .. 255 ] characters remarks
versionScope required	stringSPECIFIC_VERSIONS\|ALL_CURRENT_VERSIONS versionScope

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/vulnerability/suppress

Request samples

Payload

application/json

{"componentId": "1",
"versionIds": [0
],
"vulnerabilityName": "Vulnerability Name",
"reason": "FALSE_POSITIVE | REMEDIATED | OTHER",
"remarks": "Remarks to Suppress Vulnerability",
"versionScope": "SPECIFIC_VERSIONS | ALL_CURRENT_VERSIONS"
}

Response samples

application/json

{"componentId": "1",
"versionIds": [0
],
"vulnerabilityName": "Vulnerability Name",
"reason": "FALSE_POSITIVE | REMEDIATED | OTHER",
"remarks": "Remarks to Suppress Vulnerability",
"versionScope": "SPECIFIC_VERSIONS | ALL_CURRENT_VERSIONS"
}

Get vulnerability Suppress Details

Get vulnerability suppress details. Provide suppressId/versionId or both as inputs; either of them is mandatory. Only the system administrator has the permission to do this operation.

Request

query Parameters

suppressId	integer <int64> ID of suppression. Example: suppressId=1
componentVersionId	integer <int64> ID of component version. Example: componentVersionId=1
limit	integer <int32> Default: 25 Page size. Number Of records to fetch per page. Example: limit=1 \| default: 25
offset	integer <int32> Default: 1 Page number. Index of the page to start with (starts from 1). Example: offset=1 \| default: 1

header Parameters

authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/vulnerability/suppress/details

Response samples

application/json

{"suppressId": 0,
"vulnerabilityName": "string",
"componentName": "string",
"versionId": 0,
"versionName": "string",
"suppressedReason": "string",
"suppressedRemarks": "string",
"suppressedBy": "string",
"suppressedDate": "string"
}

UnSuppress Vulnerability

Unsuppress a vulnerability for given component versions. Only the system administrator has the permission to do this operation.

Request

header Parameters

authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Input model to unSuppress vulnerability.

vulnerabilityName required	string vulnerabilityName
componentId required	integer <int64> >= 1 componentId
versionIds	Array of integers <int64> unique versionIds
remarks required	string [ 0 .. 255 ] characters remarks

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

post/vulnerability/unSuppress

Request samples

Payload

application/json

{"vulnerabilityName": "Vulnerability Name",
"componentId": "1",
"versionIds": [0
],
"remarks": "Remarks to Unsuppress Vulnerability"
}