Home
Products
Red Hat Advanced Cluster Security for Kubernetes
4.6
API reference
Chapter 2. Version v2

Chapter 2. Version v2

2.1. ComplianceIntegrationService

2.1.1. ListComplianceIntegrations

GET /v2/compliance/integrations

ListComplianceIntegrations lists all the compliance operator metadata for the secured clusters

2.1.1.1. Description

2.1.1.2. Parameters

2.1.1.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.1.1.3. Return Type

V2ListComplianceIntegrationsResponse

2.1.1.4. Content Type

application/json

2.1.1.5. Responses

Table 2.1. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceIntegrationsResponse
0	An unexpected error response.	RpcStatus

2.1.1.6. Samples

2.1.1.7. Common object reference

2.1.1.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.1.1.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.1.1.7.3. V2COStatus

Copy to Clipboard Toggle word wrap

Represents the status of compliance operator

Represents the status of compliance operator

Enum Values
HEALTHY
UNHEALTHY

2.1.1.7.4. V2ClusterPlatformType

Enum Values
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

2.1.1.7.5. V2ClusterProviderType

Enum Values
UNSPECIFIED
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

2.1.1.7.6. V2ComplianceIntegration

Copy to Clipboard Toggle word wrap

Next Tag: 11

Next Tag: 11

Field Name	Type	Description	Format
id	String
version	String
clusterId	String
clusterName	String
namespace	String
statusErrors	List of `string`	Collection of errors that occurred while trying to obtain compliance operator health info.
operatorInstalled	Boolean
status	V2COStatus		HEALTHY, UNHEALTHY,
clusterPlatformType	V2ClusterPlatformType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
clusterProviderType	V2ClusterProviderType		UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,

2.1.1.7.7. V2ListComplianceIntegrationsResponse

Field Name	Required	Nullable	Type	Description	Format
integrations			List of V2ComplianceIntegration
totalCount			Integer		int32

2.2. ComplianceProfileService

2.2.1. GetComplianceProfile

GET /v2/compliance/profile/{id}

GetComplianceProfile retrieves the specified compliance profile

2.2.1.1. Description

2.2.1.2. Parameters

2.2.1.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.2.1.3. Return Type

V2ComplianceProfile

2.2.1.4. Content Type

application/json

2.2.1.5. Responses

Table 2.2. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceProfile
0	An unexpected error response.	RpcStatus

2.2.1.6. Samples

2.2.1.7. Common object reference

2.2.1.7.1. ComplianceRuleFix

Field Name	Required	Nullable	Type	Description	Format
platform			String
disruption			String

2.2.1.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.2.1.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.2.1.7.4. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.2.1.7.5. V2ComplianceProfile

Copy to Clipboard Toggle word wrap

Next Tag: 12

Next Tag: 12

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String
profileVersion			String
productType			String
description			String
rules			List of V2ComplianceRule
product			String
title			String
values			List of `string`
standards			List of V2ComplianceBenchmark

2.2.1.7.6. V2ComplianceRule

Field Name	Required	Nullable	Type	Description	Format
name			String
ruleType			String
severity			String
standard			String
control			String
title			String
description			String
rationale			String
fixes			List of ComplianceRuleFix
id			String
ruleId			String
parentRule			String
instructions			String
warning			String

2.2.2. ListComplianceProfiles

GET /v2/compliance/profiles/cluster

ListComplianceProfiles returns profiles matching given request

2.2.2.1. Description

2.2.2.2. Parameters

2.2.2.2.1. Query Parameters

Name	Required	Default
clusterId	-	null
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.2.2.3. Return Type

V2ListComplianceProfilesResponse

2.2.2.4. Content Type

application/json

2.2.2.5. Responses

Table 2.3. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceProfilesResponse
0	An unexpected error response.	RpcStatus

2.2.2.6. Samples

2.2.2.7. Common object reference

2.2.2.7.1. ComplianceRuleFix

Field Name	Required	Nullable	Type	Description	Format
platform			String
disruption			String

2.2.2.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.2.2.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.2.2.7.4. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.2.2.7.5. V2ComplianceProfile

Copy to Clipboard Toggle word wrap

Next Tag: 12

Next Tag: 12

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String
profileVersion			String
productType			String
description			String
rules			List of V2ComplianceRule
product			String
title			String
values			List of `string`
standards			List of V2ComplianceBenchmark

2.2.2.7.6. V2ComplianceRule

Field Name	Required	Nullable	Type	Description	Format
name			String
ruleType			String
severity			String
standard			String
control			String
title			String
description			String
rationale			String
fixes			List of ComplianceRuleFix
id			String
ruleId			String
parentRule			String
instructions			String
warning			String

2.2.2.7.7. V2ListComplianceProfilesResponse

Copy to Clipboard Toggle word wrap

ListComplianceProfilesResponse provides a list of profiles

ListComplianceProfilesResponse provides a list of profiles

Field Name	Required	Nullable	Type	Description	Format
profiles			List of V2ComplianceProfile
totalCount			Integer		int32

2.2.3. ListProfileSummaries

GET /v2/compliance/profiles/summary

ListProfileSummaries returns profiles matching each cluster and the given query

2.2.3.1. Description

2.2.3.2. Parameters

2.2.3.2.1. Query Parameters

Name	Description	Required	Default
clusterIds	`String`	-	null
query.query		-	null
query.pagination.limit		-	null
query.pagination.offset		-	null
query.pagination.sortOption.field		-	null
query.pagination.sortOption.reversed		-	null
query.pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
query.pagination.sortOption.aggregateBy.distinct		-	null

2.2.3.3. Return Type

V2ListComplianceProfileSummaryResponse

2.2.3.4. Content Type

application/json

2.2.3.5. Responses

Table 2.4. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceProfileSummaryResponse
0	An unexpected error response.	RpcStatus

2.2.3.6. Samples

2.2.3.7. Common object reference

2.2.3.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.2.3.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.2.3.7.3. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.2.3.7.4. V2ComplianceProfileSummary

Copy to Clipboard Toggle word wrap

Next Tag: 8

Next Tag: 8

Field Name	Type	Format
name	String
productType	String
description	String
title	String
ruleCount	Integer	int32
profileVersion	String
standards	List of V2ComplianceBenchmark

2.2.3.7.5. V2ListComplianceProfileSummaryResponse

Copy to Clipboard Toggle word wrap

ListComplianceProfileSummaryResponse provides a list of profiles summaries

ListComplianceProfileSummaryResponse provides a list of profiles summaries

Field Name	Required	Nullable	Type	Description	Format
profiles			List of V2ComplianceProfileSummary
totalCount			Integer		int32

2.3. ComplianceResultsService

2.3.1. GetComplianceScanCheckResult

GET /v2/compliance/scan/result/{id}

GetComplianceScanCheckResult returns the specific result by ID

2.3.1.1. Description

2.3.1.2. Parameters

2.3.1.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.3.1.3. Return Type

V2ComplianceClusterCheckStatus

2.3.1.4. Content Type

application/json

2.3.1.5. Responses

Table 2.5. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceClusterCheckStatus
0	An unexpected error response.	RpcStatus

2.3.1.6. Samples

2.3.1.7. Common object reference

2.3.1.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.3.1.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.3.1.7.3. V2ClusterCheckStatus

Copy to Clipboard Toggle word wrap

ClusterCheckStatus groups the result of the check by cluster

ClusterCheckStatus groups the result of the check by cluster

Field Name	Type	Format
cluster	V2ComplianceScanCluster
status	V2ComplianceCheckStatus	UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,
createdTime	Date	date-time
checkUid	String
lastScanTime	Date	date-time

2.3.1.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.3.1.7.5. V2ComplianceClusterCheckStatus

Copy to Clipboard Toggle word wrap

ComplianceClusterCheckStatus provides the status of a compliance check result across clusters

ComplianceClusterCheckStatus provides the status of a compliance check result across clusters

Field Name	Required	Nullable	Type	Description	Format
checkId			String
checkName			String
clusters			List of V2ClusterCheckStatus
description			String
instructions			String
rationale			String
valuesUsed			List of `string`
warnings			List of `string`
labels			Map of `string`
annotations			Map of `string`
controls			List of V2ComplianceControl

2.3.1.7.6. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.3.1.7.7. V2ComplianceScanCluster

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
clusterName			String

2.3.2. GetComplianceScanResults

GET /v2/compliance/scan/results

GetComplianceScanResults retrieves the most recent compliance operator scan results for the specified query Optional RawQuery query fields can be combined. Commonly used ones include but are not limited to - scan: id(s) of the compliance scan - cluster: id(s) of the cluster - profile: id(s) of the profile

2.3.2.1. Description

2.3.2.2. Parameters

2.3.2.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.3.2.3. Return Type

V2ListComplianceResultsResponse

2.3.2.4. Content Type

application/json

2.3.2.5. Responses

Table 2.6. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceResultsResponse
0	An unexpected error response.	RpcStatus

2.3.2.6. Samples

2.3.2.7. Common object reference

2.3.2.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.3.2.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.3.2.7.3. V2ComplianceCheckData

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
scanName			String
result			V2ComplianceCheckResult

2.3.2.7.4. V2ComplianceCheckResult

Copy to Clipboard Toggle word wrap

ComplianceCheckResult details of an instance of a compliance check result

ComplianceCheckResult details of an instance of a compliance check result

Field Name	Type	Format
checkId	String
checkName	String
checkUid	String
description	String
instructions	String
rationale	String
valuesUsed	List of `string`
warnings	List of `string`
status	V2ComplianceCheckStatus	UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,
ruleName	String
labels	Map of `string`
annotations	Map of `string`
controls	List of V2ComplianceControl

2.3.2.7.5. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.3.2.7.6. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.3.2.7.7. V2ListComplianceResultsResponse

Copy to Clipboard Toggle word wrap

ListComplianceResultsResponse provides the complete scan results

ListComplianceResultsResponse provides the complete scan results

Field Name	Required	Nullable	Type	Description	Format
scanResults			List of V2ComplianceCheckData
totalCount			Integer		int32

2.3.3. GetComplianceProfileCheckDetails

GET /v2/compliance/scan/results/profiles/{profileName}/checks/{checkName}/details

GetComplianceProfileCheckDetails

2.3.3.1. Description

2.3.3.2. Parameters

2.3.3.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null
checkName		X	null

2.3.3.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.3.3.3. Return Type

V2ComplianceClusterCheckStatus

2.3.3.4. Content Type

application/json

2.3.3.5. Responses

Table 2.7. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceClusterCheckStatus
0	An unexpected error response.	RpcStatus

2.3.3.6. Samples

2.3.3.7. Common object reference

2.3.3.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.3.3.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.3.3.7.3. V2ClusterCheckStatus

Copy to Clipboard Toggle word wrap

ClusterCheckStatus groups the result of the check by cluster

ClusterCheckStatus groups the result of the check by cluster

Field Name	Type	Format
cluster	V2ComplianceScanCluster
status	V2ComplianceCheckStatus	UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,
createdTime	Date	date-time
checkUid	String
lastScanTime	Date	date-time

2.3.3.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.3.3.7.5. V2ComplianceClusterCheckStatus

Copy to Clipboard Toggle word wrap

ComplianceClusterCheckStatus provides the status of a compliance check result across clusters

ComplianceClusterCheckStatus provides the status of a compliance check result across clusters

Field Name	Required	Nullable	Type	Description	Format
checkId			String
checkName			String
clusters			List of V2ClusterCheckStatus
description			String
instructions			String
rationale			String
valuesUsed			List of `string`
warnings			List of `string`
labels			Map of `string`
annotations			Map of `string`
controls			List of V2ComplianceControl

2.3.3.7.6. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.3.3.7.7. V2ComplianceScanCluster

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
clusterName			String

2.3.4. GetComplianceProfileCheckResult

GET /v2/compliance/scan/results/profiles/{profileName}/checks/{checkName}

GetComplianceProfileCheckResult lists status of a check per cluster

2.3.4.1. Description

2.3.4.2. Parameters

2.3.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null
checkName		X	null

2.3.4.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.3.4.3. Return Type

V2ListComplianceCheckClusterResponse

2.3.4.4. Content Type

application/json

2.3.4.5. Responses

Table 2.8. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceCheckClusterResponse
0	An unexpected error response.	RpcStatus

2.3.4.6. Samples

2.3.4.7. Common object reference

2.3.4.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.3.4.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.3.4.7.3. V2ClusterCheckStatus

Copy to Clipboard Toggle word wrap

ClusterCheckStatus groups the result of the check by cluster

ClusterCheckStatus groups the result of the check by cluster

Field Name	Type	Format
cluster	V2ComplianceScanCluster
status	V2ComplianceCheckStatus	UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,
createdTime	Date	date-time
checkUid	String
lastScanTime	Date	date-time

2.3.4.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.3.4.7.5. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.3.4.7.6. V2ComplianceScanCluster

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
clusterName			String

2.3.4.7.7. V2ListComplianceCheckClusterResponse

Copy to Clipboard Toggle word wrap

ListComplianceCheckClusterResponse provides stats per cluster

ListComplianceCheckClusterResponse provides stats per cluster

Field Name	Type	Format
checkResults	List of V2ClusterCheckStatus
profileName	String
checkName	String
totalCount	Integer	int32
controls	List of V2ComplianceControl

2.3.5. GetComplianceProfileResults

GET /v2/compliance/scan/results/profiles/{profileName}/checks

GetComplianceProfileResults retrieves the most recent compliance operator scan results for the specified query Optional RawQuery query fields can be combined.

2.3.5.1. Description

2.3.5.2. Parameters

2.3.5.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null

2.3.5.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.3.5.3. Return Type

V2ListComplianceProfileResults

2.3.5.4. Content Type

application/json

2.3.5.5. Responses

Table 2.9. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceProfileResults
0	An unexpected error response.	RpcStatus

2.3.5.6. Samples

2.3.5.7. Common object reference

2.3.5.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.3.5.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.3.5.7.3. V2ComplianceCheckResultStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
checkName			String
rationale			String
ruleName			String
checkStats			List of V2ComplianceCheckStatusCount
controls			List of V2ComplianceControl

2.3.5.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.3.5.7.5. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.3.5.7.6. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.3.5.7.7. V2ListComplianceProfileResults

Copy to Clipboard Toggle word wrap

ListComplianceProfileResults provides scan stats overview based on profile

ListComplianceProfileResults provides scan stats overview based on profile

Field Name	Type	Format
profileResults	List of V2ComplianceCheckResultStatusCount
profileName	String
totalCount	Integer	int32

2.3.6. GetComplianceProfileClusterResults

GET /v2/compliance/scan/results/profiles/{profileName}/clusters/{clusterId}

GetComplianceProfileClusterResults lists check results for a specific profile on a specific cluster

2.3.6.1. Description

2.3.6.2. Parameters

2.3.6.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null
clusterId		X	null

2.3.6.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.3.6.3. Return Type

V2ListComplianceCheckResultResponse

2.3.6.4. Content Type

application/json

2.3.6.5. Responses

Table 2.10. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceCheckResultResponse
0	An unexpected error response.	RpcStatus

2.3.6.6. Samples

2.3.6.7. Common object reference

2.3.6.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.3.6.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.3.6.7.3. V2ComplianceCheckResult

Copy to Clipboard Toggle word wrap

ComplianceCheckResult details of an instance of a compliance check result

ComplianceCheckResult details of an instance of a compliance check result

Field Name	Type	Format
checkId	String
checkName	String
checkUid	String
description	String
instructions	String
rationale	String
valuesUsed	List of `string`
warnings	List of `string`
status	V2ComplianceCheckStatus	UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,
ruleName	String
labels	Map of `string`
annotations	Map of `string`
controls	List of V2ComplianceControl

2.3.6.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.3.6.7.5. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.3.6.7.6. V2ListComplianceCheckResultResponse

Field Name	Type	Format
checkResults	List of V2ComplianceCheckResult
profileName	String
clusterId	String
totalCount	Integer	int32
lastScanTime	Date	date-time

2.3.7. GetComplianceScanConfigurationResults

GET /v2/compliance/scan/results/{scanConfigName}

GetComplianceScanConfigurationResults retrieves the most recent compliance operator scan results for the specified query Optional RawQuery query fields can be combined.

2.3.7.1. Description

2.3.7.2. Parameters

2.3.7.2.1. Path Parameters

Name	Description	Required	Default	Pattern
scanConfigName		X	null

2.3.7.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.3.7.3. Return Type

V2ListComplianceResultsResponse

2.3.7.4. Content Type

application/json

2.3.7.5. Responses

Table 2.11. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceResultsResponse
0	An unexpected error response.	RpcStatus

2.3.7.6. Samples

2.3.7.7. Common object reference

2.3.7.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.3.7.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.3.7.7.3. V2ComplianceCheckData

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
scanName			String
result			V2ComplianceCheckResult

2.3.7.7.4. V2ComplianceCheckResult

Copy to Clipboard Toggle word wrap

ComplianceCheckResult details of an instance of a compliance check result

ComplianceCheckResult details of an instance of a compliance check result

Field Name	Type	Format
checkId	String
checkName	String
checkUid	String
description	String
instructions	String
rationale	String
valuesUsed	List of `string`
warnings	List of `string`
status	V2ComplianceCheckStatus	UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,
ruleName	String
labels	Map of `string`
annotations	Map of `string`
controls	List of V2ComplianceControl

2.3.7.7.5. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.3.7.7.6. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.3.7.7.7. V2ListComplianceResultsResponse

Copy to Clipboard Toggle word wrap

ListComplianceResultsResponse provides the complete scan results

ListComplianceResultsResponse provides the complete scan results

Field Name	Required	Nullable	Type	Description	Format
scanResults			List of V2ComplianceCheckData
totalCount			Integer		int32

2.4. ComplianceResultsStatsService

2.4.1. GetComplianceOverallClusterStats

GET /v2/compliance/scan/stats/overall/cluster

Deprecated in favor of GetComplianceClusterStats

2.4.1.1. Description

2.4.1.2. Parameters

2.4.1.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.4.1.3. Return Type

V2ListComplianceClusterOverallStatsResponse

2.4.1.4. Content Type

application/json

2.4.1.5. Responses

Table 2.12. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceClusterOverallStatsResponse
0	An unexpected error response.	RpcStatus

2.4.1.6. Samples

2.4.1.7. Common object reference

2.4.1.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.4.1.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.4.1.7.3. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.4.1.7.4. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.4.1.7.5. V2ComplianceClusterOverallStats

Copy to Clipboard Toggle word wrap

ComplianceClusterOverallStats provides overall stats for cluster

ComplianceClusterOverallStats provides overall stats for cluster

Field Name	Type	Format
cluster	V2ComplianceScanCluster
checkStats	List of V2ComplianceCheckStatusCount
clusterErrors	List of `string`
lastScanTime	Date	date-time

2.4.1.7.6. V2ComplianceScanCluster

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
clusterName			String

2.4.1.7.7. V2ListComplianceClusterOverallStatsResponse

Copy to Clipboard Toggle word wrap

ListComplianceCheckScanStatsResponse provides stats per cluster

ListComplianceCheckScanStatsResponse provides stats per cluster

Field Name	Required	Nullable	Type	Description	Format
scanStats			List of V2ComplianceClusterOverallStats
totalCount			Integer		int32

2.4.2. GetComplianceProfilesClusterStats

GET /v2/compliance/scan/stats/profiles/clusters/{clusterId}

GetComplianceProfilesClusterStats lists cluster stats grouped by profile

2.4.2.1. Description

2.4.2.2. Parameters

2.4.2.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

2.4.2.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.4.2.3. Return Type

V2ListComplianceClusterProfileStatsResponse

2.4.2.4. Content Type

application/json

2.4.2.5. Responses

Table 2.13. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceClusterProfileStatsResponse
0	An unexpected error response.	RpcStatus

2.4.2.6. Samples

2.4.2.7. Common object reference

2.4.2.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.4.2.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.4.2.7.3. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.4.2.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.4.2.7.5. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.4.2.7.6. V2ComplianceProfileScanStats

Copy to Clipboard Toggle word wrap

ComplianceProfileScanStats provides scan stats overview based on profile

ComplianceProfileScanStats provides scan stats overview based on profile

Field Name	Required	Nullable	Type	Description	Format
checkStats			List of V2ComplianceCheckStatusCount
profileName			String
title			String
version			String
benchmarks			List of V2ComplianceBenchmark

2.4.2.7.7. V2ListComplianceClusterProfileStatsResponse

Copy to Clipboard Toggle word wrap

ListComplianceClusterProfileStatsResponse provides stats for the profiles within the scans

ListComplianceClusterProfileStatsResponse provides stats for the profiles within the scans

Field Name	Type	Format
scanStats	List of V2ComplianceProfileScanStats
clusterId	String
clusterName	String
totalCount	Integer	int32

2.4.3. GetComplianceProfilesStats

GET /v2/compliance/scan/stats/profiles

GetComplianceProfileScanStats lists current scan stats grouped by profile Optional RawQuery query fields can be combined. Commonly used ones include but are not limited to - scan: id(s) of the compliance scan - cluster: id(s) of the cluster - profile: id(s) of the profile

2.4.3.1. Description

2.4.3.2. Parameters

2.4.3.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.4.3.3. Return Type

V2ListComplianceProfileScanStatsResponse

2.4.3.4. Content Type

application/json

2.4.3.5. Responses

Table 2.14. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceProfileScanStatsResponse
0	An unexpected error response.	RpcStatus

2.4.3.6. Samples

2.4.3.7. Common object reference

2.4.3.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.4.3.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.4.3.7.3. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.4.3.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.4.3.7.5. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.4.3.7.6. V2ComplianceProfileScanStats

Copy to Clipboard Toggle word wrap

ComplianceProfileScanStats provides scan stats overview based on profile

ComplianceProfileScanStats provides scan stats overview based on profile

Field Name	Required	Nullable	Type	Description	Format
checkStats			List of V2ComplianceCheckStatusCount
profileName			String
title			String
version			String
benchmarks			List of V2ComplianceBenchmark

2.4.3.7.7. V2ListComplianceProfileScanStatsResponse

Copy to Clipboard Toggle word wrap

ListComplianceProfileScanStatsResponse provides stats for the profiles within the scans

ListComplianceProfileScanStatsResponse provides stats for the profiles within the scans

Field Name	Required	Nullable	Type	Description	Format
scanStats			List of V2ComplianceProfileScanStats
totalCount			Integer		int32

2.4.4. GetComplianceProfileCheckStats

GET /v2/compliance/scan/stats/profiles/{profileName}/checks/{checkName}

GetComplianceProfileCheckStats lists current stats for a specific cluster check

2.4.4.1. Description

2.4.4.2. Parameters

2.4.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null
checkName		X	null

2.4.4.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.4.4.3. Return Type

V2ListComplianceProfileResults

2.4.4.4. Content Type

application/json

2.4.4.5. Responses

Table 2.15. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceProfileResults
0	An unexpected error response.	RpcStatus

2.4.4.6. Samples

2.4.4.7. Common object reference

2.4.4.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.4.4.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.4.4.7.3. V2ComplianceCheckResultStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
checkName			String
rationale			String
ruleName			String
checkStats			List of V2ComplianceCheckStatusCount
controls			List of V2ComplianceControl

2.4.4.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.4.4.7.5. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.4.4.7.6. V2ComplianceControl

Field Name	Required	Nullable	Type	Description	Format
standard			String
control			String

2.4.4.7.7. V2ListComplianceProfileResults

Copy to Clipboard Toggle word wrap

ListComplianceProfileResults provides scan stats overview based on profile

ListComplianceProfileResults provides scan stats overview based on profile

Field Name	Type	Format
profileResults	List of V2ComplianceCheckResultStatusCount
profileName	String
totalCount	Integer	int32

2.4.5. GetComplianceClusterStats

GET /v2/compliance/scan/stats/profiles/{profileName}/clusters

2.4.5.1. Description

2.4.5.2. Parameters

2.4.5.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null

2.4.5.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.4.5.3. Return Type

V2ListComplianceClusterOverallStatsResponse

2.4.5.4. Content Type

application/json

2.4.5.5. Responses

Table 2.16. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceClusterOverallStatsResponse
0	An unexpected error response.	RpcStatus

2.4.5.6. Samples

2.4.5.7. Common object reference

2.4.5.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.4.5.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.4.5.7.3. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.4.5.7.4. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.4.5.7.5. V2ComplianceClusterOverallStats

Copy to Clipboard Toggle word wrap

ComplianceClusterOverallStats provides overall stats for cluster

ComplianceClusterOverallStats provides overall stats for cluster

Field Name	Type	Format
cluster	V2ComplianceScanCluster
checkStats	List of V2ComplianceCheckStatusCount
clusterErrors	List of `string`
lastScanTime	Date	date-time

2.4.5.7.6. V2ComplianceScanCluster

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
clusterName			String

2.4.5.7.7. V2ListComplianceClusterOverallStatsResponse

Copy to Clipboard Toggle word wrap

ListComplianceCheckScanStatsResponse provides stats per cluster

ListComplianceCheckScanStatsResponse provides stats per cluster

Field Name	Required	Nullable	Type	Description	Format
scanStats			List of V2ComplianceClusterOverallStats
totalCount			Integer		int32

2.4.6. GetComplianceProfileStats

GET /v2/compliance/scan/stats/profiles/{profileName}

GetComplianceProfileStats lists current scan stats grouped by profile Optional RawQuery query fields can be combined. Commonly used ones include but are not limited to - scan: id(s) of the compliance scan - cluster: id(s) of the cluster - profile: id(s) of the profile

2.4.6.1. Description

2.4.6.2. Parameters

2.4.6.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null

2.4.6.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.4.6.3. Return Type

V2ListComplianceProfileScanStatsResponse

2.4.6.4. Content Type

application/json

2.4.6.5. Responses

Table 2.17. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceProfileScanStatsResponse
0	An unexpected error response.	RpcStatus

2.4.6.6. Samples

2.4.6.7. Common object reference

2.4.6.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.4.6.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.4.6.7.3. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.4.6.7.4. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.4.6.7.5. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.4.6.7.6. V2ComplianceProfileScanStats

Copy to Clipboard Toggle word wrap

ComplianceProfileScanStats provides scan stats overview based on profile

ComplianceProfileScanStats provides scan stats overview based on profile

Field Name	Required	Nullable	Type	Description	Format
checkStats			List of V2ComplianceCheckStatusCount
profileName			String
title			String
version			String
benchmarks			List of V2ComplianceBenchmark

2.4.6.7.7. V2ListComplianceProfileScanStatsResponse

Copy to Clipboard Toggle word wrap

ListComplianceProfileScanStatsResponse provides stats for the profiles within the scans

ListComplianceProfileScanStatsResponse provides stats for the profiles within the scans

Field Name	Required	Nullable	Type	Description	Format
scanStats			List of V2ComplianceProfileScanStats
totalCount			Integer		int32

2.4.7. GetComplianceClusterScanStats

GET /v2/compliance/stats/configurations/clusters/{clusterId}

GetComplianceClusterScanStats lists the current scan stats for a cluster for each scan configuration

2.4.7.1. Description

2.4.7.2. Parameters

2.4.7.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

2.4.7.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.4.7.3. Return Type

V2ListComplianceClusterScanStatsResponse

2.4.7.4. Content Type

application/json

2.4.7.5. Responses

Table 2.18. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceClusterScanStatsResponse
0	An unexpected error response.	RpcStatus

2.4.7.6. Samples

2.4.7.7. Common object reference

2.4.7.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.4.7.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.4.7.7.3. V2ComplianceCheckStatus

Enum Values
UNSET_CHECK_STATUS
PASS
FAIL
ERROR
INFO
MANUAL
NOT_APPLICABLE
INCONSISTENT

2.4.7.7.4. V2ComplianceCheckStatusCount

Copy to Clipboard Toggle word wrap

Group the number of occurrences by status

Group the number of occurrences by status

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32
status			V2ComplianceCheckStatus		UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

2.4.7.7.5. V2ComplianceClusterScanStats

Copy to Clipboard Toggle word wrap

ComplianceClusterScanStats provides scan stats overview based on cluster

ComplianceClusterScanStats provides scan stats overview based on cluster

Field Name	Required	Nullable	Type	Description	Format
scanStats			V2ComplianceScanStatsShim
cluster			V2ComplianceScanCluster

2.4.7.7.6. V2ComplianceScanCluster

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
clusterName			String

2.4.7.7.7. V2ComplianceScanStatsShim

Copy to Clipboard Toggle word wrap

ComplianceScanStatsShim models statistics of checks for a given scan configuration

ComplianceScanStatsShim models statistics of checks for a given scan configuration

Field Name	Type	Format
scanName	String
checkStats	List of V2ComplianceCheckStatusCount
lastScan	Date	date-time
scanConfigId	String

2.4.7.7.8. V2ListComplianceClusterScanStatsResponse

Copy to Clipboard Toggle word wrap

ListComplianceClusterScanStatsResponse provides stats for the clusters within the scans

ListComplianceClusterScanStatsResponse provides stats for the clusters within the scans

Field Name	Required	Nullable	Type	Description	Format
scanStats			List of V2ComplianceClusterScanStats
totalCount			Integer		int32

2.5. ComplianceRuleService

2.5.1. GetComplianceRule

GET /v2/compliance/rule/summary/{ruleName}

GetComplianceRule returns rule matching given request

2.5.1.1. Description

2.5.1.2. Parameters

2.5.1.2.1. Path Parameters

Name	Description	Required	Default	Pattern
ruleName		X	null

2.5.1.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.5.1.3. Return Type

V2ComplianceRule

2.5.1.4. Content Type

application/json

2.5.1.5. Responses

Table 2.19. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceRule
0	An unexpected error response.	RpcStatus

2.5.1.6. Samples

2.5.1.7. Common object reference

2.5.1.7.1. ComplianceRuleFix

Field Name	Required	Nullable	Type	Description	Format
platform			String
disruption			String

2.5.1.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.5.1.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.5.1.7.4. V2ComplianceRule

Field Name	Required	Nullable	Type	Description	Format
name			String
ruleType			String
severity			String
standard			String
control			String
title			String
description			String
rationale			String
fixes			List of ComplianceRuleFix
id			String
ruleId			String
parentRule			String
instructions			String
warning			String

2.6. ComplianceScanConfigurationService

2.6.1. ListComplianceScanConfigClusterProfiles

GET /v2/compliance/scan/configurations/clusters/{clusterId}/profiles/collection

GetComplianceScanConfiguration retrieves the specified compliance scan configurations

2.6.1.1. Description

2.6.1.2. Parameters

2.6.1.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

2.6.1.2.2. Query Parameters

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

2.6.1.3. Return Type

V2ListComplianceScanConfigsClusterProfileResponse

2.6.1.4. Content Type

application/json

2.6.1.5. Responses

Table 2.20. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceScanConfigsClusterProfileResponse
0	An unexpected error response.	RpcStatus

2.6.1.6. Samples

2.6.1.7. Common object reference

2.6.1.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.1.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.1.7.3. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.6.1.7.4. V2ComplianceProfileSummary

Copy to Clipboard Toggle word wrap

Next Tag: 8

Next Tag: 8

Field Name	Type	Format
name	String
productType	String
description	String
title	String
ruleCount	Integer	int32
profileVersion	String
standards	List of V2ComplianceBenchmark

2.6.1.7.5. V2ListComplianceScanConfigsClusterProfileResponse

Field Name	Type	Format
clusterId	String
clusterName	String
profiles	List of V2ComplianceProfileSummary
totalCount	Integer	int32

2.6.2. ListComplianceScanConfigurations

GET /v2/compliance/scan/configurations

ListComplianceScanConfigurations lists all the compliance operator scan configurations for the secured clusters

2.6.2.1. Description

2.6.2.2. Parameters

2.6.2.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.6.2.3. Return Type

V2ListComplianceScanConfigurationsResponse

2.6.2.4. Content Type

application/json

2.6.2.5. Responses

Table 2.21. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceScanConfigurationsResponse
0	An unexpected error response.	RpcStatus

2.6.2.6. Samples

2.6.2.7. Common object reference

2.6.2.7.1. ClusterScanStatusSuiteStatus

Copy to Clipboard Toggle word wrap

Additional scan status gathered from ComplianceSuite

Additional scan status gathered from ComplianceSuite

Field Name	Type	Format
phase	String
result	String
errorMessage	String
lastTransitionTime	Date	date-time

2.6.2.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.2.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.2.7.4. V2BaseComplianceScanConfigurationSettings

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
oneTimeScan			Boolean
profiles			List of `string`
scanSchedule			V2Schedule
description			String
notifiers			List of V2NotifierConfiguration

2.6.2.7.5. V2ClusterScanStatus

Copy to Clipboard Toggle word wrap

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
errors			List of `string`
clusterName			String
suiteStatus			ClusterScanStatusSuiteStatus

2.6.2.7.6. V2ComplianceScanConfigurationStatus

Copy to Clipboard Toggle word wrap

Next available tag: 9

Next available tag: 9

Field Name	Type	Format
id	String
scanName	String
scanConfig	V2BaseComplianceScanConfigurationSettings
clusterStatus	List of V2ClusterScanStatus
createdTime	Date	date-time
lastUpdatedTime	Date	date-time
modifiedBy	V2SlimUser
lastExecutedTime	Date	date-time

2.6.2.7.7. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.6.2.7.8. V2ListComplianceScanConfigurationsResponse

Field Name	Required	Nullable	Type	Description	Format
configurations			List of V2ComplianceScanConfigurationStatus
totalCount			Integer		int32

2.6.2.7.9. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.6.2.7.10. V2Schedule

Field Name	Type	Format
intervalType	V2ScheduleIntervalType	UNSET, WEEKLY, MONTHLY, DAILY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ScheduleDaysOfWeek
daysOfMonth	V2ScheduleDaysOfMonth

2.6.2.7.11. V2ScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.2.7.12. V2ScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.2.7.13. V2ScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY
DAILY

2.6.2.7.14. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.6.3. DeleteComplianceScanConfiguration

DELETE /v2/compliance/scan/configurations/{id}

DeleteComplianceScanConfiguration removes the compliance scan configuration with given Name

2.6.3.1. Description

2.6.3.2. Parameters

2.6.3.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.6.3.3. Return Type

Object

2.6.3.4. Content Type

application/json

2.6.3.5. Responses

Table 2.22. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.6.3.6. Samples

2.6.3.7. Common object reference

2.6.3.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.3.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.4. GetComplianceScanConfiguration

GET /v2/compliance/scan/configurations/{id}

GetComplianceScanConfiguration retrieves the specified compliance scan configurations

2.6.4.1. Description

2.6.4.2. Parameters

2.6.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.6.4.3. Return Type

V2ComplianceScanConfigurationStatus

2.6.4.4. Content Type

application/json

2.6.4.5. Responses

Table 2.23. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceScanConfigurationStatus
0	An unexpected error response.	RpcStatus

2.6.4.6. Samples

2.6.4.7. Common object reference

2.6.4.7.1. ClusterScanStatusSuiteStatus

Copy to Clipboard Toggle word wrap

Additional scan status gathered from ComplianceSuite

Additional scan status gathered from ComplianceSuite

Field Name	Type	Format
phase	String
result	String
errorMessage	String
lastTransitionTime	Date	date-time

2.6.4.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.4.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.4.7.4. V2BaseComplianceScanConfigurationSettings

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
oneTimeScan			Boolean
profiles			List of `string`
scanSchedule			V2Schedule
description			String
notifiers			List of V2NotifierConfiguration

2.6.4.7.5. V2ClusterScanStatus

Copy to Clipboard Toggle word wrap

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
errors			List of `string`
clusterName			String
suiteStatus			ClusterScanStatusSuiteStatus

2.6.4.7.6. V2ComplianceScanConfigurationStatus

Copy to Clipboard Toggle word wrap

Next available tag: 9

Next available tag: 9

Field Name	Type	Format
id	String
scanName	String
scanConfig	V2BaseComplianceScanConfigurationSettings
clusterStatus	List of V2ClusterScanStatus
createdTime	Date	date-time
lastUpdatedTime	Date	date-time
modifiedBy	V2SlimUser
lastExecutedTime	Date	date-time

2.6.4.7.7. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.6.4.7.8. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.6.4.7.9. V2Schedule

Field Name	Type	Format
intervalType	V2ScheduleIntervalType	UNSET, WEEKLY, MONTHLY, DAILY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ScheduleDaysOfWeek
daysOfMonth	V2ScheduleDaysOfMonth

2.6.4.7.10. V2ScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.4.7.11. V2ScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.4.7.12. V2ScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY
DAILY

2.6.4.7.13. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.6.5. UpdateComplianceScanConfiguration

PUT /v2/compliance/scan/configurations/{id}

UpdateComplianceScanConfiguration updates a compliance scan configuration

2.6.5.1. Description

2.6.5.2. Parameters

2.6.5.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.6.5.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	ComplianceScanConfigurationServiceUpdateComplianceScanConfigurationBody	X

2.6.5.3. Return Type

Object

2.6.5.4. Content Type

application/json

2.6.5.5. Responses

Table 2.24. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.6.5.6. Samples

2.6.5.7. Common object reference

2.6.5.7.1. ComplianceScanConfigurationServiceUpdateComplianceScanConfigurationBody

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
scanName			String
scanConfig			V2BaseComplianceScanConfigurationSettings
clusters			List of `string`

2.6.5.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.5.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.5.7.4. V2BaseComplianceScanConfigurationSettings

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
oneTimeScan			Boolean
profiles			List of `string`
scanSchedule			V2Schedule
description			String
notifiers			List of V2NotifierConfiguration

2.6.5.7.5. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.6.5.7.6. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.6.5.7.7. V2Schedule

Field Name	Type	Format
intervalType	V2ScheduleIntervalType	UNSET, WEEKLY, MONTHLY, DAILY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ScheduleDaysOfWeek
daysOfMonth	V2ScheduleDaysOfMonth

2.6.5.7.8. V2ScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.5.7.9. V2ScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.5.7.10. V2ScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY
DAILY

2.6.6. GetReportHistory

GET /v2/compliance/scan/configurations/{id}/reports/history

GetReportHistory returns a list of snapshots (scan executions) from a given scan configuration.

2.6.6.1. Description

2.6.6.2. Parameters

2.6.6.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.6.6.2.2. Query Parameters

Name	Required	Default
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

2.6.6.3. Return Type

V2ComplianceReportHistoryResponse

2.6.6.4. Content Type

application/json

2.6.6.5. Responses

Table 2.25. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceReportHistoryResponse
0	An unexpected error response.	RpcStatus

2.6.6.6. Samples

2.6.6.7. Common object reference

2.6.6.7.1. ClusterScanStatusSuiteStatus

Copy to Clipboard Toggle word wrap

Additional scan status gathered from ComplianceSuite

Additional scan status gathered from ComplianceSuite

Field Name	Type	Format
phase	String
result	String
errorMessage	String
lastTransitionTime	Date	date-time

2.6.6.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.6.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.6.7.4. V2BaseComplianceScanConfigurationSettings

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
oneTimeScan			Boolean
profiles			List of `string`
scanSchedule			V2Schedule
description			String
notifiers			List of V2NotifierConfiguration

2.6.6.7.5. V2ClusterScanStatus

Copy to Clipboard Toggle word wrap

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
errors			List of `string`
clusterName			String
suiteStatus			ClusterScanStatusSuiteStatus

2.6.6.7.6. V2ComplianceReportHistoryResponse

Field Name	Required	Nullable	Type	Description	Format
complianceReportSnapshots			List of V2ComplianceReportSnapshot

2.6.6.7.7. V2ComplianceReportSnapshot

Field Name	Required	Nullable	Type	Description	Format
reportJobId			String
scanConfigId			String
name			String
description			String
reportStatus			V2ComplianceReportStatus
reportData			V2ComplianceScanConfigurationStatus
user			V2SlimUser
isDownloadAvailable			Boolean

2.6.6.7.8. V2ComplianceReportStatus

Field Name	Type	Format
runState	V2ComplianceReportStatusRunState	WAITING, PREPARING, GENERATED, DELIVERED, FAILURE,
startedAt	Date	date-time
completedAt	Date	date-time
errorMsg	String
reportRequestType	V2ComplianceReportStatusReportMethod	ON_DEMAND, SCHEDULED,
reportNotificationMethod	V2NotificationMethod	EMAIL, DOWNLOAD,

2.6.6.7.9. V2ComplianceReportStatusReportMethod

Enum Values
ON_DEMAND
SCHEDULED

2.6.6.7.10. V2ComplianceReportStatusRunState

Enum Values
WAITING
PREPARING
GENERATED
DELIVERED
FAILURE

2.6.6.7.11. V2ComplianceScanConfigurationStatus

Copy to Clipboard Toggle word wrap

Next available tag: 9

Next available tag: 9

Field Name	Type	Format
id	String
scanName	String
scanConfig	V2BaseComplianceScanConfigurationSettings
clusterStatus	List of V2ClusterScanStatus
createdTime	Date	date-time
lastUpdatedTime	Date	date-time
modifiedBy	V2SlimUser
lastExecutedTime	Date	date-time

2.6.6.7.12. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.6.6.7.13. V2NotificationMethod

Enum Values
EMAIL
DOWNLOAD

2.6.6.7.14. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.6.6.7.15. V2Schedule

Field Name	Type	Format
intervalType	V2ScheduleIntervalType	UNSET, WEEKLY, MONTHLY, DAILY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ScheduleDaysOfWeek
daysOfMonth	V2ScheduleDaysOfMonth

2.6.6.7.16. V2ScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.6.7.17. V2ScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.6.7.18. V2ScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY
DAILY

2.6.6.7.19. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.6.7. GetMyReportHistory

GET /v2/compliance/scan/configurations/{id}/reports/my-history

GetMyReportHistory returns a list of snapshots (scan executions) executed by the current user from a given scan configuration.

2.6.7.1. Description

2.6.7.2. Parameters

2.6.7.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.6.7.2.2. Query Parameters

Name	Required	Default
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

2.6.7.3. Return Type

V2ComplianceReportHistoryResponse

2.6.7.4. Content Type

application/json

2.6.7.5. Responses

Table 2.26. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceReportHistoryResponse
0	An unexpected error response.	RpcStatus

2.6.7.6. Samples

2.6.7.7. Common object reference

2.6.7.7.1. ClusterScanStatusSuiteStatus

Copy to Clipboard Toggle word wrap

Additional scan status gathered from ComplianceSuite

Additional scan status gathered from ComplianceSuite

Field Name	Type	Format
phase	String
result	String
errorMessage	String
lastTransitionTime	Date	date-time

2.6.7.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.7.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.7.7.4. V2BaseComplianceScanConfigurationSettings

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
oneTimeScan			Boolean
profiles			List of `string`
scanSchedule			V2Schedule
description			String
notifiers			List of V2NotifierConfiguration

2.6.7.7.5. V2ClusterScanStatus

Copy to Clipboard Toggle word wrap

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
clusterId			String
errors			List of `string`
clusterName			String
suiteStatus			ClusterScanStatusSuiteStatus

2.6.7.7.6. V2ComplianceReportHistoryResponse

Field Name	Required	Nullable	Type	Description	Format
complianceReportSnapshots			List of V2ComplianceReportSnapshot

2.6.7.7.7. V2ComplianceReportSnapshot

Field Name	Required	Nullable	Type	Description	Format
reportJobId			String
scanConfigId			String
name			String
description			String
reportStatus			V2ComplianceReportStatus
reportData			V2ComplianceScanConfigurationStatus
user			V2SlimUser
isDownloadAvailable			Boolean

2.6.7.7.8. V2ComplianceReportStatus

Field Name	Type	Format
runState	V2ComplianceReportStatusRunState	WAITING, PREPARING, GENERATED, DELIVERED, FAILURE,
startedAt	Date	date-time
completedAt	Date	date-time
errorMsg	String
reportRequestType	V2ComplianceReportStatusReportMethod	ON_DEMAND, SCHEDULED,
reportNotificationMethod	V2NotificationMethod	EMAIL, DOWNLOAD,

2.6.7.7.9. V2ComplianceReportStatusReportMethod

Enum Values
ON_DEMAND
SCHEDULED

2.6.7.7.10. V2ComplianceReportStatusRunState

Enum Values
WAITING
PREPARING
GENERATED
DELIVERED
FAILURE

2.6.7.7.11. V2ComplianceScanConfigurationStatus

Copy to Clipboard Toggle word wrap

Next available tag: 9

Next available tag: 9

Field Name	Type	Format
id	String
scanName	String
scanConfig	V2BaseComplianceScanConfigurationSettings
clusterStatus	List of V2ClusterScanStatus
createdTime	Date	date-time
lastUpdatedTime	Date	date-time
modifiedBy	V2SlimUser
lastExecutedTime	Date	date-time

2.6.7.7.12. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.6.7.7.13. V2NotificationMethod

Enum Values
EMAIL
DOWNLOAD

2.6.7.7.14. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.6.7.7.15. V2Schedule

Field Name	Type	Format
intervalType	V2ScheduleIntervalType	UNSET, WEEKLY, MONTHLY, DAILY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ScheduleDaysOfWeek
daysOfMonth	V2ScheduleDaysOfMonth

2.6.7.7.16. V2ScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.7.7.17. V2ScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.7.7.18. V2ScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY
DAILY

2.6.7.7.19. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.6.8. RunComplianceScanConfiguration

POST /v2/compliance/scan/configurations/{id}/run

RunComplianceScanConfiguration launches scan for the specified scan configuration, which will invoke scans to run for the applicable profiles across the configured clusters.

2.6.8.1. Description

2.6.8.2. Parameters

2.6.8.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.6.8.3. Return Type

Object

2.6.8.4. Content Type

application/json

2.6.8.5. Responses

Table 2.27. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.6.8.6. Samples

2.6.8.7. Common object reference

2.6.8.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.8.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.9. CreateComplianceScanConfiguration

POST /v2/compliance/scan/configurations

CreateComplianceScanConfiguration creates a compliance scan configuration

2.6.9.1. Description

2.6.9.2. Parameters

2.6.9.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V2ComplianceScanConfiguration	X

2.6.9.3. Return Type

V2ComplianceScanConfiguration

2.6.9.4. Content Type

application/json

2.6.9.5. Responses

Table 2.28. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceScanConfiguration
0	An unexpected error response.	RpcStatus

2.6.9.6. Samples

2.6.9.7. Common object reference

2.6.9.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.9.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.9.7.3. V2BaseComplianceScanConfigurationSettings

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
oneTimeScan			Boolean
profiles			List of `string`
scanSchedule			V2Schedule
description			String
notifiers			List of V2NotifierConfiguration

2.6.9.7.4. V2ComplianceScanConfiguration

Copy to Clipboard Toggle word wrap

Next available tag: 5

Next available tag: 5

Field Name	Required	Nullable	Type	Description	Format
id			String
scanName			String
scanConfig			V2BaseComplianceScanConfigurationSettings
clusters			List of `string`

2.6.9.7.5. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.6.9.7.6. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.6.9.7.7. V2Schedule

Field Name	Type	Format
intervalType	V2ScheduleIntervalType	UNSET, WEEKLY, MONTHLY, DAILY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ScheduleDaysOfWeek
daysOfMonth	V2ScheduleDaysOfMonth

2.6.9.7.8. V2ScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.9.7.9. V2ScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.6.9.7.10. V2ScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY
DAILY

2.6.10. ListComplianceScanConfigProfiles

GET /v2/compliance/scan/configurations/profiles/collection

ListComplianceScanConfigurations lists all the compliance operator scan configurations for the secured clusters

2.6.10.1. Description

2.6.10.2. Parameters

2.6.10.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.6.10.3. Return Type

V2ListComplianceScanConfigsProfileResponse

2.6.10.4. Content Type

application/json

2.6.10.5. Responses

Table 2.29. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListComplianceScanConfigsProfileResponse
0	An unexpected error response.	RpcStatus

2.6.10.6. Samples

2.6.10.7. Common object reference

2.6.10.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.10.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.10.7.3. V2ComplianceBenchmark

Field Name	Required	Nullable	Type	Description	Format
name			String
version			String
description			String
provider			String
shortName			String

2.6.10.7.4. V2ComplianceProfileSummary

Copy to Clipboard Toggle word wrap

Next Tag: 8

Next Tag: 8

Field Name	Type	Format
name	String
productType	String
description	String
title	String
ruleCount	Integer	int32
profileVersion	String
standards	List of V2ComplianceBenchmark

2.6.10.7.5. V2ListComplianceScanConfigsProfileResponse

Field Name	Required	Nullable	Type	Description	Format
profiles			List of V2ComplianceProfileSummary
totalCount			Integer		int32

2.6.11. DeleteReport

DELETE /v2/compliance/scan/configurations/reports/{id}

DeleteReport deletes a given snapshot (scan execution).

2.6.11.1. Description

2.6.11.2. Parameters

2.6.11.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.6.11.3. Return Type

Object

2.6.11.4. Content Type

application/json

2.6.11.5. Responses

Table 2.30. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.6.11.6. Samples

2.6.11.7. Common object reference

2.6.11.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.11.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.12. RunReport

POST /v2/compliance/scan/configurations/reports/run

RunReport runs an on demand compliance report for the scan configuration

2.6.12.1. Description

2.6.12.2. Parameters

2.6.12.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V2ComplianceRunReportRequest	X

2.6.12.3. Return Type

V2ComplianceRunReportResponse

2.6.12.4. Content Type

application/json

2.6.12.5. Responses

Table 2.31. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ComplianceRunReportResponse
0	An unexpected error response.	RpcStatus

2.6.12.6. Samples

2.6.12.7. Common object reference

2.6.12.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.6.12.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.6.12.7.3. V2ComplianceRunReportRequest

Field Name	Required	Nullable	Type	Description	Format
scanConfigId			String
reportNotificationMethod			V2NotificationMethod		EMAIL, DOWNLOAD,

2.6.12.7.4. V2ComplianceRunReportResponse

Field Name	Type	Format
runState	V2ComplianceRunReportResponseRunState	SUBMITTED, ERROR,
submittedAt	Date	date-time
errorMsg	String

2.6.12.7.5. V2ComplianceRunReportResponseRunState

Enum Values
SUBMITTED
ERROR

2.6.12.7.6. V2NotificationMethod

Enum Values
EMAIL
DOWNLOAD

2.7. ReportService

2.7.1. CountReportConfigurations

GET /v2/reports/configuration-count

CountReportConfigurations returns the number of report configurations.

2.7.1.1. Description

2.7.1.2. Parameters

2.7.1.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.7.1.3. Return Type

V2CountReportConfigurationsResponse

2.7.1.4. Content Type

application/json

2.7.1.5. Responses

Table 2.32. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2CountReportConfigurationsResponse
0	An unexpected error response.	RpcStatus

2.7.1.6. Samples

2.7.1.7. Common object reference

2.7.1.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.1.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.1.7.3. V2CountReportConfigurationsResponse

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32

2.7.2. ListReportConfigurations

GET /v2/reports/configurations

ListReportConfigurations returns report configurations matching given query

2.7.2.1. Description

2.7.2.2. Parameters

2.7.2.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.7.2.3. Return Type

V2ListReportConfigurationsResponse

2.7.2.4. Content Type

application/json

2.7.2.5. Responses

Table 2.33. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListReportConfigurationsResponse
0	An unexpected error response.	RpcStatus

2.7.2.6. Samples

2.7.2.7. Common object reference

2.7.2.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.2.7.2. ReportConfigurationReportType

Enum Values
VULNERABILITY

2.7.2.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.2.7.4. V2CollectionReference

Field Name	Required	Nullable	Type	Description	Format
collectionId			String
collectionName			String

2.7.2.7.5. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.7.2.7.6. V2ListReportConfigurationsResponse

Field Name	Required	Nullable	Type	Description	Format
reportConfigs			List of V2ReportConfiguration

2.7.2.7.7. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.7.2.7.8. V2ReportConfiguration

Field Name	Type	Format
id	String
name	String
description	String
type	ReportConfigurationReportType	VULNERABILITY,
vulnReportFilters	V2VulnerabilityReportFilters
schedule	V2ReportSchedule
resourceScope	V2ResourceScope
notifiers	List of V2NotifierConfiguration

2.7.2.7.9. V2ReportSchedule

Field Name	Type	Format
intervalType	V2ReportScheduleIntervalType	UNSET, WEEKLY, MONTHLY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ReportScheduleDaysOfWeek
daysOfMonth	V2ReportScheduleDaysOfMonth

2.7.2.7.10. V2ReportScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.2.7.11. V2ReportScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.2.7.12. V2ReportScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY

2.7.2.7.13. V2ResourceScope

Field Name	Required	Nullable	Type	Description	Format
collectionScope			V2CollectionReference

2.7.2.7.14. V2VulnerabilityReportFilters

Field Name	Type	Format
fixability	VulnerabilityReportFiltersFixability	BOTH, FIXABLE, NOT_FIXABLE,
severities	List of VulnerabilityReportFiltersVulnerabilitySeverity
imageTypes	List of VulnerabilityReportFiltersImageType
allVuln	Boolean
sinceLastSentScheduledReport	Boolean
sinceStartDate	Date	date-time
includeNvdCvss	Boolean

2.7.2.7.15. VulnerabilityReportFiltersFixability

Enum Values
BOTH
FIXABLE
NOT_FIXABLE

2.7.2.7.16. VulnerabilityReportFiltersImageType

Enum Values
DEPLOYED
WATCHED

2.7.2.7.17. VulnerabilityReportFiltersVulnerabilitySeverity

Enum Values
UNKNOWN_VULNERABILITY_SEVERITY
LOW_VULNERABILITY_SEVERITY
MODERATE_VULNERABILITY_SEVERITY
IMPORTANT_VULNERABILITY_SEVERITY
CRITICAL_VULNERABILITY_SEVERITY

2.7.3. DeleteReportConfiguration

DELETE /v2/reports/configurations/{id}

DeleteReportConfiguration removes the report configuration with given ID

2.7.3.1. Description

2.7.3.2. Parameters

2.7.3.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.3.3. Return Type

Object

2.7.3.4. Content Type

application/json

2.7.3.5. Responses

Table 2.34. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.7.3.6. Samples

2.7.3.7. Common object reference

2.7.3.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.3.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.4. GetReportConfiguration

GET /v2/reports/configurations/{id}

GetReportConfiguration returns the report configuration with given ID

2.7.4.1. Description

2.7.4.2. Parameters

2.7.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.4.3. Return Type

V2ReportConfiguration

2.7.4.4. Content Type

application/json

2.7.4.5. Responses

Table 2.35. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ReportConfiguration
0	An unexpected error response.	RpcStatus

2.7.4.6. Samples

2.7.4.7. Common object reference

2.7.4.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.4.7.2. ReportConfigurationReportType

Enum Values
VULNERABILITY

2.7.4.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.4.7.4. V2CollectionReference

Field Name	Required	Nullable	Type	Description	Format
collectionId			String
collectionName			String

2.7.4.7.5. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.7.4.7.6. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.7.4.7.7. V2ReportConfiguration

Field Name	Type	Format
id	String
name	String
description	String
type	ReportConfigurationReportType	VULNERABILITY,
vulnReportFilters	V2VulnerabilityReportFilters
schedule	V2ReportSchedule
resourceScope	V2ResourceScope
notifiers	List of V2NotifierConfiguration

2.7.4.7.8. V2ReportSchedule

Field Name	Type	Format
intervalType	V2ReportScheduleIntervalType	UNSET, WEEKLY, MONTHLY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ReportScheduleDaysOfWeek
daysOfMonth	V2ReportScheduleDaysOfMonth

2.7.4.7.9. V2ReportScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.4.7.10. V2ReportScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.4.7.11. V2ReportScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY

2.7.4.7.12. V2ResourceScope

Field Name	Required	Nullable	Type	Description	Format
collectionScope			V2CollectionReference

2.7.4.7.13. V2VulnerabilityReportFilters

Field Name	Type	Format
fixability	VulnerabilityReportFiltersFixability	BOTH, FIXABLE, NOT_FIXABLE,
severities	List of VulnerabilityReportFiltersVulnerabilitySeverity
imageTypes	List of VulnerabilityReportFiltersImageType
allVuln	Boolean
sinceLastSentScheduledReport	Boolean
sinceStartDate	Date	date-time
includeNvdCvss	Boolean

2.7.4.7.14. VulnerabilityReportFiltersFixability

Enum Values
BOTH
FIXABLE
NOT_FIXABLE

2.7.4.7.15. VulnerabilityReportFiltersImageType

Enum Values
DEPLOYED
WATCHED

2.7.4.7.16. VulnerabilityReportFiltersVulnerabilitySeverity

Enum Values
UNKNOWN_VULNERABILITY_SEVERITY
LOW_VULNERABILITY_SEVERITY
MODERATE_VULNERABILITY_SEVERITY
IMPORTANT_VULNERABILITY_SEVERITY
CRITICAL_VULNERABILITY_SEVERITY

2.7.5. GetReportHistory

GET /v2/reports/configurations/{id}/history

GetReportHistory returns the full report job history for a report configuration with the specified ID.

2.7.5.1. Description

2.7.5.2. Parameters

2.7.5.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.5.2.2. Query Parameters

Name	Required	Default
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

2.7.5.3. Return Type

V2ReportHistoryResponse

2.7.5.4. Content Type

application/json

2.7.5.5. Responses

Table 2.36. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ReportHistoryResponse
0	An unexpected error response.	RpcStatus

2.7.5.6. Samples

2.7.5.7. Common object reference

2.7.5.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.5.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.5.7.3. V2CollectionSnapshot

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.7.5.7.4. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.7.5.7.5. V2NotificationMethod

Enum Values
EMAIL
DOWNLOAD

2.7.5.7.6. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.7.5.7.7. V2ReportHistoryResponse

Field Name	Required	Nullable	Type	Description	Format
reportSnapshots			List of V2ReportSnapshot

2.7.5.7.8. V2ReportSchedule

Field Name	Type	Format
intervalType	V2ReportScheduleIntervalType	UNSET, WEEKLY, MONTHLY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ReportScheduleDaysOfWeek
daysOfMonth	V2ReportScheduleDaysOfMonth

2.7.5.7.9. V2ReportScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.5.7.10. V2ReportScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.5.7.11. V2ReportScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY

2.7.5.7.12. V2ReportSnapshot

Field Name	Required	Nullable	Type	Description	Format
reportConfigId			String
reportJobId			String
name			String
description			String
vulnReportFilters			V2VulnerabilityReportFilters
collectionSnapshot			V2CollectionSnapshot
schedule			V2ReportSchedule
reportStatus			V2ReportStatus
notifiers			List of V2NotifierConfiguration
user			V2SlimUser
isDownloadAvailable			Boolean

2.7.5.7.13. V2ReportStatus

Field Name	Type	Format
runState	V2ReportStatusRunState	WAITING, PREPARING, GENERATED, DELIVERED, FAILURE,
completedAt	Date	date-time
errorMsg	String
reportRequestType	V2ReportStatusReportMethod	ON_DEMAND, SCHEDULED,
reportNotificationMethod	V2NotificationMethod	EMAIL, DOWNLOAD,

2.7.5.7.14. V2ReportStatusReportMethod

Enum Values
ON_DEMAND
SCHEDULED

2.7.5.7.15. V2ReportStatusRunState

Enum Values
WAITING
PREPARING
GENERATED
DELIVERED
FAILURE

2.7.5.7.16. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.7.5.7.17. V2VulnerabilityReportFilters

Field Name	Type	Format
fixability	VulnerabilityReportFiltersFixability	BOTH, FIXABLE, NOT_FIXABLE,
severities	List of VulnerabilityReportFiltersVulnerabilitySeverity
imageTypes	List of VulnerabilityReportFiltersImageType
allVuln	Boolean
sinceLastSentScheduledReport	Boolean
sinceStartDate	Date	date-time
includeNvdCvss	Boolean

2.7.5.7.18. VulnerabilityReportFiltersFixability

Enum Values
BOTH
FIXABLE
NOT_FIXABLE

2.7.5.7.19. VulnerabilityReportFiltersImageType

Enum Values
DEPLOYED
WATCHED

2.7.5.7.20. VulnerabilityReportFiltersVulnerabilitySeverity

Enum Values
UNKNOWN_VULNERABILITY_SEVERITY
LOW_VULNERABILITY_SEVERITY
MODERATE_VULNERABILITY_SEVERITY
IMPORTANT_VULNERABILITY_SEVERITY
CRITICAL_VULNERABILITY_SEVERITY

2.7.6. GetMyReportHistory

GET /v2/reports/configurations/{id}/my-history

GetMyReportHistory returns the requester’s report job history for a report configuration with the specified ID.

2.7.6.1. Description

2.7.6.2. Parameters

2.7.6.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.6.2.2. Query Parameters

Name	Required	Default
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

2.7.6.3. Return Type

V2ReportHistoryResponse

2.7.6.4. Content Type

application/json

2.7.6.5. Responses

Table 2.37. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ReportHistoryResponse
0	An unexpected error response.	RpcStatus

2.7.6.6. Samples

2.7.6.7. Common object reference

2.7.6.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.6.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.6.7.3. V2CollectionSnapshot

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.7.6.7.4. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.7.6.7.5. V2NotificationMethod

Enum Values
EMAIL
DOWNLOAD

2.7.6.7.6. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.7.6.7.7. V2ReportHistoryResponse

Field Name	Required	Nullable	Type	Description	Format
reportSnapshots			List of V2ReportSnapshot

2.7.6.7.8. V2ReportSchedule

Field Name	Type	Format
intervalType	V2ReportScheduleIntervalType	UNSET, WEEKLY, MONTHLY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ReportScheduleDaysOfWeek
daysOfMonth	V2ReportScheduleDaysOfMonth

2.7.6.7.9. V2ReportScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.6.7.10. V2ReportScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.6.7.11. V2ReportScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY

2.7.6.7.12. V2ReportSnapshot

Field Name	Required	Nullable	Type	Description	Format
reportConfigId			String
reportJobId			String
name			String
description			String
vulnReportFilters			V2VulnerabilityReportFilters
collectionSnapshot			V2CollectionSnapshot
schedule			V2ReportSchedule
reportStatus			V2ReportStatus
notifiers			List of V2NotifierConfiguration
user			V2SlimUser
isDownloadAvailable			Boolean

2.7.6.7.13. V2ReportStatus

Field Name	Type	Format
runState	V2ReportStatusRunState	WAITING, PREPARING, GENERATED, DELIVERED, FAILURE,
completedAt	Date	date-time
errorMsg	String
reportRequestType	V2ReportStatusReportMethod	ON_DEMAND, SCHEDULED,
reportNotificationMethod	V2NotificationMethod	EMAIL, DOWNLOAD,

2.7.6.7.14. V2ReportStatusReportMethod

Enum Values
ON_DEMAND
SCHEDULED

2.7.6.7.15. V2ReportStatusRunState

Enum Values
WAITING
PREPARING
GENERATED
DELIVERED
FAILURE

2.7.6.7.16. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.7.6.7.17. V2VulnerabilityReportFilters

Field Name	Type	Format
fixability	VulnerabilityReportFiltersFixability	BOTH, FIXABLE, NOT_FIXABLE,
severities	List of VulnerabilityReportFiltersVulnerabilitySeverity
imageTypes	List of VulnerabilityReportFiltersImageType
allVuln	Boolean
sinceLastSentScheduledReport	Boolean
sinceStartDate	Date	date-time
includeNvdCvss	Boolean

2.7.6.7.18. VulnerabilityReportFiltersFixability

Enum Values
BOTH
FIXABLE
NOT_FIXABLE

2.7.6.7.19. VulnerabilityReportFiltersImageType

Enum Values
DEPLOYED
WATCHED

2.7.6.7.20. VulnerabilityReportFiltersVulnerabilitySeverity

Enum Values
UNKNOWN_VULNERABILITY_SEVERITY
LOW_VULNERABILITY_SEVERITY
MODERATE_VULNERABILITY_SEVERITY
IMPORTANT_VULNERABILITY_SEVERITY
CRITICAL_VULNERABILITY_SEVERITY

2.7.7. UpdateReportConfiguration

PUT /v2/reports/configurations/{id}

UpdateReportConfiguration updates a report configuration

2.7.7.1. Description

2.7.7.2. Parameters

2.7.7.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.7.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	ReportServiceUpdateReportConfigurationBody	X

2.7.7.3. Return Type

Object

2.7.7.4. Content Type

application/json

2.7.7.5. Responses

Table 2.38. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.7.7.6. Samples

2.7.7.7. Common object reference

2.7.7.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.7.7.2. ReportConfigurationReportType

Enum Values
VULNERABILITY

2.7.7.7.3. ReportServiceUpdateReportConfigurationBody

Field Name	Type	Format
name	String
description	String
type	ReportConfigurationReportType	VULNERABILITY,
vulnReportFilters	V2VulnerabilityReportFilters
schedule	V2ReportSchedule
resourceScope	V2ResourceScope
notifiers	List of V2NotifierConfiguration

2.7.7.7.4. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.7.7.5. V2CollectionReference

Field Name	Required	Nullable	Type	Description	Format
collectionId			String
collectionName			String

2.7.7.7.6. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.7.7.7.7. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.7.7.7.8. V2ReportSchedule

Field Name	Type	Format
intervalType	V2ReportScheduleIntervalType	UNSET, WEEKLY, MONTHLY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ReportScheduleDaysOfWeek
daysOfMonth	V2ReportScheduleDaysOfMonth

2.7.7.7.9. V2ReportScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.7.7.10. V2ReportScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.7.7.11. V2ReportScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY

2.7.7.7.12. V2ResourceScope

Field Name	Required	Nullable	Type	Description	Format
collectionScope			V2CollectionReference

2.7.7.7.13. V2VulnerabilityReportFilters

Field Name	Type	Format
fixability	VulnerabilityReportFiltersFixability	BOTH, FIXABLE, NOT_FIXABLE,
severities	List of VulnerabilityReportFiltersVulnerabilitySeverity
imageTypes	List of VulnerabilityReportFiltersImageType
allVuln	Boolean
sinceLastSentScheduledReport	Boolean
sinceStartDate	Date	date-time
includeNvdCvss	Boolean

2.7.7.7.14. VulnerabilityReportFiltersFixability

Enum Values
BOTH
FIXABLE
NOT_FIXABLE

2.7.7.7.15. VulnerabilityReportFiltersImageType

Enum Values
DEPLOYED
WATCHED

2.7.7.7.16. VulnerabilityReportFiltersVulnerabilitySeverity

Enum Values
UNKNOWN_VULNERABILITY_SEVERITY
LOW_VULNERABILITY_SEVERITY
MODERATE_VULNERABILITY_SEVERITY
IMPORTANT_VULNERABILITY_SEVERITY
CRITICAL_VULNERABILITY_SEVERITY

2.7.8. PostReportConfiguration

POST /v2/reports/configurations

PostReportConfiguration creates a report configuration

2.7.8.1. Description

2.7.8.2. Parameters

2.7.8.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V2ReportConfiguration	X

2.7.8.3. Return Type

V2ReportConfiguration

2.7.8.4. Content Type

application/json

2.7.8.5. Responses

Table 2.39. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ReportConfiguration
0	An unexpected error response.	RpcStatus

2.7.8.6. Samples

2.7.8.7. Common object reference

2.7.8.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.8.7.2. ReportConfigurationReportType

Enum Values
VULNERABILITY

2.7.8.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.8.7.4. V2CollectionReference

Field Name	Required	Nullable	Type	Description	Format
collectionId			String
collectionName			String

2.7.8.7.5. V2EmailNotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
notifierId			String
mailingLists			List of `string`
customSubject			String
customBody			String

2.7.8.7.6. V2NotifierConfiguration

Field Name	Required	Nullable	Type	Description	Format
emailConfig			V2EmailNotifierConfiguration
notifierName			String

2.7.8.7.7. V2ReportConfiguration

Field Name	Type	Format
id	String
name	String
description	String
type	ReportConfigurationReportType	VULNERABILITY,
vulnReportFilters	V2VulnerabilityReportFilters
schedule	V2ReportSchedule
resourceScope	V2ResourceScope
notifiers	List of V2NotifierConfiguration

2.7.8.7.8. V2ReportSchedule

Field Name	Type	Format
intervalType	V2ReportScheduleIntervalType	UNSET, WEEKLY, MONTHLY,
hour	Integer	int32
minute	Integer	int32
daysOfWeek	V2ReportScheduleDaysOfWeek
daysOfMonth	V2ReportScheduleDaysOfMonth

2.7.8.7.9. V2ReportScheduleDaysOfMonth

Copy to Clipboard Toggle word wrap

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.8.7.10. V2ReportScheduleDaysOfWeek

Copy to Clipboard Toggle word wrap

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

2.7.8.7.11. V2ReportScheduleIntervalType

Enum Values
UNSET
WEEKLY
MONTHLY

2.7.8.7.12. V2ResourceScope

Field Name	Required	Nullable	Type	Description	Format
collectionScope			V2CollectionReference

2.7.8.7.13. V2VulnerabilityReportFilters

Field Name	Type	Format
fixability	VulnerabilityReportFiltersFixability	BOTH, FIXABLE, NOT_FIXABLE,
severities	List of VulnerabilityReportFiltersVulnerabilitySeverity
imageTypes	List of VulnerabilityReportFiltersImageType
allVuln	Boolean
sinceLastSentScheduledReport	Boolean
sinceStartDate	Date	date-time
includeNvdCvss	Boolean

2.7.8.7.14. VulnerabilityReportFiltersFixability

Enum Values
BOTH
FIXABLE
NOT_FIXABLE

2.7.8.7.15. VulnerabilityReportFiltersImageType

Enum Values
DEPLOYED
WATCHED

2.7.8.7.16. VulnerabilityReportFiltersVulnerabilitySeverity

Enum Values
UNKNOWN_VULNERABILITY_SEVERITY
LOW_VULNERABILITY_SEVERITY
MODERATE_VULNERABILITY_SEVERITY
IMPORTANT_VULNERABILITY_SEVERITY
CRITICAL_VULNERABILITY_SEVERITY

2.7.9. CancelReport

DELETE /v2/reports/jobs/{id}/cancel

Cancels a queued report job for the given report id. If the job is not active, it is a noop. If a report is already being prepared, it won’t be cancelled.

2.7.9.1. Description

2.7.9.2. Parameters

2.7.9.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.9.3. Return Type

Object

2.7.9.4. Content Type

application/json

2.7.9.5. Responses

Table 2.40. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.7.9.6. Samples

2.7.9.7. Common object reference

2.7.9.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.9.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.10. DeleteReport

DELETE /v2/reports/jobs/{id}/delete

Deletes a generated report for the given report id

2.7.10.1. Description

2.7.10.2. Parameters

2.7.10.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.10.3. Return Type

Object

2.7.10.4. Content Type

application/json

2.7.10.5. Responses

Table 2.41. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.7.10.6. Samples

2.7.10.7. Common object reference

2.7.10.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.10.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.11. GetReportStatus

GET /v2/reports/jobs/{id}/status

GetReportStatus returns report status for the given report id

2.7.11.1. Description

2.7.11.2. Parameters

2.7.11.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.7.11.3. Return Type

V2ReportStatusResponse

2.7.11.4. Content Type

application/json

2.7.11.5. Responses

Table 2.42. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ReportStatusResponse
0	An unexpected error response.	RpcStatus

2.7.11.6. Samples

2.7.11.7. Common object reference

2.7.11.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.11.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.11.7.3. V2NotificationMethod

Enum Values
EMAIL
DOWNLOAD

2.7.11.7.4. V2ReportStatus

Field Name	Type	Format
runState	V2ReportStatusRunState	WAITING, PREPARING, GENERATED, DELIVERED, FAILURE,
completedAt	Date	date-time
errorMsg	String
reportRequestType	V2ReportStatusReportMethod	ON_DEMAND, SCHEDULED,
reportNotificationMethod	V2NotificationMethod	EMAIL, DOWNLOAD,

2.7.11.7.5. V2ReportStatusReportMethod

Enum Values
ON_DEMAND
SCHEDULED

2.7.11.7.6. V2ReportStatusResponse

Field Name	Required	Nullable	Type	Description	Format
status			V2ReportStatus

2.7.11.7.7. V2ReportStatusRunState

Enum Values
WAITING
PREPARING
GENERATED
DELIVERED
FAILURE

2.7.12. RunReport

POST /v2/reports/run

Submits a new report generation request if the user requesting this report does not have another waiting or preparing report for the same report configuration.

2.7.12.1. Description

2.7.12.2. Parameters

2.7.12.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V2RunReportRequest	X

2.7.12.3. Return Type

V2RunReportResponse

2.7.12.4. Content Type

application/json

2.7.12.5. Responses

Table 2.43. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2RunReportResponse
0	An unexpected error response.	RpcStatus

2.7.12.6. Samples

2.7.12.7. Common object reference

2.7.12.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.7.12.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.7.12.7.3. V2NotificationMethod

Enum Values
EMAIL
DOWNLOAD

2.7.12.7.4. V2RunReportRequest

Field Name	Required	Nullable	Type	Description	Format
reportConfigId			String
reportNotificationMethod			V2NotificationMethod		EMAIL, DOWNLOAD,

2.7.12.7.5. V2RunReportResponse

Field Name	Required	Nullable	Type	Description	Format
reportConfigId			String
reportId			String

2.8. VulnerabilityExceptionService

2.8.1. CreateDeferVulnerabilityException

POST /v2/vulnerability-exceptions/deferral

CreateDeferVulnerabilityException creates an exception request to defer specified vulnerabilities. Once an exception is created, it remains in the PENDING state until the approval. The exception is enforced only after it is approved. Once the exception expires, it is garbage collected as per the retention configuration .expiredVulnReqRetentionDurationDays (GET`/v1/config/`)

2.8.1.1. Description

2.8.1.2. Parameters

2.8.1.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V2CreateDeferVulnerabilityExceptionRequest	X

2.8.1.3. Return Type

V2CreateDeferVulnerabilityExceptionResponse

2.8.1.4. Content Type

application/json

2.8.1.5. Responses

Table 2.44. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2CreateDeferVulnerabilityExceptionResponse
0	An unexpected error response.	RpcStatus

2.8.1.6. Samples

2.8.1.7. Common object reference

2.8.1.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.1.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.1.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.1.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.1.7.5. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.1.7.6. V2CreateDeferVulnerabilityExceptionRequest

Copy to Clipboard Toggle word wrap

next available tag: 6

next available tag: 6

Field Name	Type	Description
cves	List of `string`	REQUIRED. The CVEs to which the exception should be applied.
comment	String	REQUIRED. The rationale for creating the exception.
scope	VulnerabilityExceptionScope
exceptionExpiry	V2ExceptionExpiry

2.8.1.7.7. V2CreateDeferVulnerabilityExceptionResponse

Field Name	Required	Nullable	Type	Description	Format
exception			V2VulnerabilityException

2.8.1.7.8. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.1.7.9. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.1.7.10. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.1.7.11. 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

2.8.1.7.12. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.1.7.13. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.1.7.14. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.1.7.15. 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

2.8.1.7.16. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.2. CreateFalsePositiveVulnerabilityException

POST /v2/vulnerability-exceptions/false-positive

CreateFalsePositiveVulnerabilityException creates an exception request to mark specified vulnerabilities as false positive. Once an exception is created, it remains in the PENDING state until the approval. The exception is enforced only after it is approved.

2.8.2.1. Description

2.8.2.2. Parameters

2.8.2.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V2CreateFalsePositiveVulnerabilityExceptionRequest	X

2.8.2.3. Return Type

V2CreateFalsePositiveVulnerabilityExceptionResponse

2.8.2.4. Content Type

application/json

2.8.2.5. Responses

Table 2.45. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2CreateFalsePositiveVulnerabilityExceptionResponse
0	An unexpected error response.	RpcStatus

2.8.2.6. Samples

2.8.2.7. Common object reference

2.8.2.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.2.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.2.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.2.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.2.7.5. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.2.7.6. V2CreateFalsePositiveVulnerabilityExceptionRequest

Field Name	Type	Description
cves	List of `string`	REQUIRED. The CVEs to which the exception should be applied.
scope	VulnerabilityExceptionScope
comment	String	REQUIRED. The rationale for creating the exception.

2.8.2.7.7. V2CreateFalsePositiveVulnerabilityExceptionResponse

Field Name	Required	Nullable	Type	Description	Format
exception			V2VulnerabilityException

2.8.2.7.8. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.2.7.9. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.2.7.10. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.2.7.11. 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

2.8.2.7.12. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.2.7.13. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.2.7.14. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.2.7.15. 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

2.8.2.7.16. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.3. ListVulnerabilityExceptions

GET /v2/vulnerability-exceptions

ListVulnerabilityExceptions returns a list of vulnerability exceptions.

2.8.3.1. Description

2.8.3.2. Parameters

2.8.3.2.1. Query Parameters

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

2.8.3.3. Return Type

V2ListVulnerabilityExceptionsResponse

2.8.3.4. Content Type

application/json

2.8.3.5. Responses

Table 2.46. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ListVulnerabilityExceptionsResponse
0	An unexpected error response.	RpcStatus

2.8.3.6. Samples

2.8.3.7. Common object reference

2.8.3.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.3.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.3.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.3.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.3.7.5. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.3.7.6. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.3.7.7. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.3.7.8. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.3.7.9. 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

2.8.3.7.10. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.3.7.11. V2ListVulnerabilityExceptionsResponse

Field Name	Required	Nullable	Type	Description	Format
exceptions			List of V2VulnerabilityException

2.8.3.7.12. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.3.7.13. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.3.7.14. 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

2.8.3.7.15. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.4. 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.

2.8.4.1. Description

2.8.4.2. Parameters

2.8.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id	REQUIRED. The ID of vulnerability exception to be approved.	X	null

2.8.4.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	VulnerabilityExceptionServiceApproveVulnerabilityExceptionBody	X

2.8.4.3. Return Type

V2ApproveVulnerabilityExceptionResponse

2.8.4.4. Content Type

application/json

2.8.4.5. Responses

Table 2.47. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2ApproveVulnerabilityExceptionResponse
0	An unexpected error response.	RpcStatus

2.8.4.6. Samples

2.8.4.7. Common object reference

2.8.4.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.4.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.4.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.4.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.4.7.5. V2ApproveVulnerabilityExceptionResponse

Field Name	Required	Nullable	Type	Description	Format
exception			V2VulnerabilityException

2.8.4.7.6. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.4.7.7. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.4.7.8. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.4.7.9. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.4.7.10. 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

2.8.4.7.11. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.4.7.12. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.4.7.13. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.4.7.14. 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

2.8.4.7.15. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.4.7.16. VulnerabilityExceptionServiceApproveVulnerabilityExceptionBody

Field Name	Required	Nullable	Type	Description	Format
comment			String	REQUIRED. The rationale for approving the exception.

2.8.5. CancelVulnerabilityException

POST /v2/vulnerability-exceptions/{id}/cancel

CancelVulnerabilityException cancels a vulnerability exception. Once cancelled, an approved exception is no longer enforced. Cancelled exceptions are garbage collected as per the retention configuration .expiredVulnReqRetentionDurationDays (GET /v1/config/).

2.8.5.1. Description

2.8.5.2. Parameters

2.8.5.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.8.5.3. Return Type

V2CancelVulnerabilityExceptionResponse

2.8.5.4. Content Type

application/json

2.8.5.5. Responses

Table 2.48. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2CancelVulnerabilityExceptionResponse
0	An unexpected error response.	RpcStatus

2.8.5.6. Samples

2.8.5.7. Common object reference

2.8.5.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.5.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.5.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.5.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.5.7.5. V2CancelVulnerabilityExceptionResponse

Field Name	Required	Nullable	Type	Description	Format
exception			V2VulnerabilityException

2.8.5.7.6. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.5.7.7. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.5.7.8. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.5.7.9. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.5.7.10. 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

2.8.5.7.11. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.5.7.12. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.5.7.13. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.5.7.14. 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

2.8.5.7.15. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.6. DeleteVulnerabilityException

DELETE /v2/vulnerability-exceptions/{id}

DeleteVulnerabilityException deletes a vulnerability exception. Only pending exceptions and pending updates to an enforced exception can be deleted. To revert an exception use cancel API. All exceptions are retained in the system according to the retention configuration.

2.8.6.1. Description

2.8.6.2. Parameters

2.8.6.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.8.6.3. Return Type

Object

2.8.6.4. Content Type

application/json

2.8.6.5. Responses

Table 2.49. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RpcStatus

2.8.6.6. Samples

2.8.6.7. Common object reference

2.8.6.7.1. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.6.7.2. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.7. DenyVulnerabilityException

POST /v2/vulnerability-exceptions/{id}/deny

DenyVulnerabilityException denies a vulnerability exception. Denied exceptions are inactive and are garbage collected as per the retention configuration .expiredVulnReqRetentionDurationDays (GET`/v1/config/`)

2.8.7.1. Description

2.8.7.2. Parameters

2.8.7.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id	REQUIRED. The ID of vulnerability exception to be denied.	X	null

2.8.7.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	VulnerabilityExceptionServiceDenyVulnerabilityExceptionBody	X

2.8.7.3. Return Type

V2DenyVulnerabilityExceptionResponse

2.8.7.4. Content Type

application/json

2.8.7.5. Responses

Table 2.50. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2DenyVulnerabilityExceptionResponse
0	An unexpected error response.	RpcStatus

2.8.7.6. Samples

2.8.7.7. Common object reference

2.8.7.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.7.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.7.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.7.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.7.7.5. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.7.7.6. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.7.7.7. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.7.7.8. V2DenyVulnerabilityExceptionResponse

Field Name	Required	Nullable	Type	Description	Format
exception			V2VulnerabilityException

2.8.7.7.9. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.7.7.10. 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

2.8.7.7.11. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.7.7.12. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.7.7.13. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.7.7.14. 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

2.8.7.7.15. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.7.7.16. VulnerabilityExceptionServiceDenyVulnerabilityExceptionBody

Field Name	Required	Nullable	Type	Description	Format
comment			String	REQUIRED. The rationale for denying the exception.

2.8.8. GetVulnerabilityException

GET /v2/vulnerability-exceptions/{id}

GetVulnerabilityException returns the vulnerability exception with specified ID.

2.8.8.1. Description

2.8.8.2. Parameters

2.8.8.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

2.8.8.3. Return Type

V2GetVulnerabilityExceptionResponse

2.8.8.4. Content Type

application/json

2.8.8.5. Responses

Table 2.51. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2GetVulnerabilityExceptionResponse
0	An unexpected error response.	RpcStatus

2.8.8.6. Samples

2.8.8.7. Common object reference

2.8.8.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.8.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.8.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.8.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.8.7.5. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.8.7.6. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.8.7.7. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.8.7.8. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.8.7.9. 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

2.8.8.7.10. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.8.7.11. V2GetVulnerabilityExceptionResponse

Field Name	Required	Nullable	Type	Description	Format
exception			V2VulnerabilityException

2.8.8.7.12. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.8.7.13. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.8.7.14. 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

2.8.8.7.15. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.9. UpdateVulnerabilityException

PATCH /v2/vulnerability-exceptions/{id}

UpdateVulnerabilityException updates an existing vulnerability exception. The update is enforced only once it is approved. Currently only the following can be updated: - CVEs and expiry of the deferral exceptions - CVEs of the false positive exception

2.8.9.1. Description

2.8.9.2. Parameters

2.8.9.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id	REQUIRED. The ID of vulnerability exception to be updated.	X	null

2.8.9.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	VulnerabilityExceptionServiceUpdateVulnerabilityExceptionBody	X

2.8.9.3. Return Type

V2UpdateVulnerabilityExceptionResponse

2.8.9.4. Content Type

application/json

2.8.9.5. Responses

Table 2.52. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V2UpdateVulnerabilityExceptionResponse
0	An unexpected error response.	RpcStatus

2.8.9.6. Samples

2.8.9.7. Common object reference

2.8.9.7.1. ExceptionExpiryExpiryType

Enum Values
TIME
ALL_CVE_FIXABLE
ANY_CVE_FIXABLE

2.8.9.7.2. ProtobufAny

Field Name	Required	Nullable	Type	Description	Format
@type			String

2.8.9.7.3. RpcStatus

Field Name	Type	Format
code	Integer	int32
message	String
details	List of ProtobufAny

2.8.9.7.4. ScopeImage

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String

2.8.9.7.5. V2Comment

Field Name	Type	Format
id	String
message	String
user	V2SlimUser
createdAt	Date	date-time

2.8.9.7.6. V2DeferralRequest

Field Name	Required	Nullable	Type	Description	Format
expiry			V2ExceptionExpiry

2.8.9.7.7. V2DeferralUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a deferral exception.
expiry			V2ExceptionExpiry

2.8.9.7.8. V2ExceptionExpiry

Field Name	Required	Nullable	Type	Description	Format
expiryType			ExceptionExpiryExpiryType		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

2.8.9.7.9. 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

2.8.9.7.10. V2FalsePositiveUpdate

Field Name	Required	Nullable	Type	Description	Format
cves			List of `string`	Use this field to update the CVEs of a false-positive exception.

2.8.9.7.11. V2SlimUser

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String

2.8.9.7.12. V2UpdateVulnerabilityExceptionResponse

Field Name	Required	Nullable	Type	Description	Format
exception			V2VulnerabilityException

2.8.9.7.13. V2VulnerabilityException

Next available tag: 16 VulnerabilityException represents a vulnerability exception such as deferral and false-positive.

Field Name	Type	Description	Format
id	String
name	String	Auto-generated display name of the exception.
targetState	V2VulnerabilityState		OBSERVED, DEFERRED, FALSE_POSITIVE,
status	V2ExceptionStatus		PENDING, APPROVED, DENIED, APPROVED_PENDING_UPDATE,
expired	Boolean	If set to `true`, this field indicates that the exception is no longer enforced.
requester	V2SlimUser
approvers	List of V2SlimUser
createdAt	Date		date-time
lastUpdated	Date		date-time
comments	List of V2Comment
scope	VulnerabilityExceptionScope
deferralRequest	V2DeferralRequest
falsePositiveRequest	Object
cves	List of `string`	Indicates the CVEs to which the exception applies.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate

2.8.9.7.14. 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

2.8.9.7.15. VulnerabilityExceptionScope

Field Name	Required	Nullable	Type	Description	Format
imageScope			ScopeImage

2.8.9.7.16. VulnerabilityExceptionServiceUpdateVulnerabilityExceptionBody

Field Name	Type	Description
comment	String	REQUIRED. The rationale for updating the exception.
deferralUpdate	V2DeferralUpdate
falsePositiveUpdate	V2FalsePositiveUpdate