ApproveVulnerabilityException
POST /v2/vulnerability-exceptions/{id}/approve
ApproveVulnerabilityException approves a vulnerability exception. Once approved, the exception is enforced. The associated vulnerabilities are excluded from policy evaluation and risk evaluation, and the vulnerabilities may not appear in certain APIs responses by default.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
REQUIRED. The ID of vulnerability exception to be approved. |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
VulnerabilityExceptionServiceApproveVulnerabilityExceptionBody |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
A successful response. |
|
0 |
An unexpected error response. |
Common object reference
RpcStatus
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
ScopeImage
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
registry |
String |
||||
remote |
String |
||||
tag |
String |
V2ApproveVulnerabilityExceptionResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
exception |
V2Comment
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
message |
String |
||||
user |
|||||
createdAt |
Date |
date-time |
V2DeferralUpdate
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
cves |
List of |
Use this field to update the CVEs of a deferral exception. |
|||
expiry |
V2ExceptionExpiry
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
expiryType |
TIME, ALL_CVE_FIXABLE, ANY_CVE_FIXABLE, |
||||
expiresOn |
Date |
Indicates the timestamp when the exception expires. This field is REQUIRED only if the expiry type is set to TIME. |
date-time |
V2ExceptionStatus
Indicates the status of a request.
-
PENDING: Default request state. It indicates that the request has not been fulfilled and that an action (approve/deny) is required.
-
APPROVED: Indicates that the request has been approved by the approver.
-
DENIED: Indicates that the request has been denied by the approver.
-
APPROVED_PENDING_UPDATE: Indicates that the original request was approved, but an update is still pending an approval or denial.
| Enum Values |
|---|
PENDING |
APPROVED |
DENIED |
APPROVED_PENDING_UPDATE |
V2FalsePositiveUpdate
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
cves |
List of |
Use this field to update the CVEs of a false-positive exception. |
V2VulnerabilityException
Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
name |
String |
Auto-generated display name of the exception. |
|||
targetState |
OBSERVED, DEFERRED, FALSE_POSITIVE, |
||||
status |
PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE, |
||||
expired |
Boolean |
If set to |
|||
requester |
|||||
approvers |
List of V2SlimUser |
||||
createdAt |
Date |
date-time |
|||
lastUpdated |
Date |
date-time |
|||
comments |
List of V2Comment |
||||
scope |
|||||
deferralRequest |
|||||
falsePositiveRequest |
Object |
||||
cves |
List of |
Indicates the CVEs to which the exception applies. |
|||
deferralUpdate |
|||||
falsePositiveUpdate |
V2VulnerabilityState
VulnerabilityState are the possible applicable to CVE. By default all vulnerabilities are in observed state.
-
OBSERVED: This is the default state and indicates that the CVE is not excluded from policy evaluation and risk evaluation.
-
DEFERRED: Indicates that the vulnerability is deferred. A deferred CVE is excluded from policy evaluation and risk evaluation.
-
FALSE_POSITIVE: Indicates that the vulnerability is a false-positive. A false-positive CVE is excluded from policy evaluation and risk evaluation.
| Enum Values |
|---|
OBSERVED |
DEFERRED |
FALSE_POSITIVE |