Home
Products
Red Hat Advanced Cluster Security for Kubernetes
4.6
API reference
Chapter 17. Compliance Results Stats Service

Chapter 17. Compliance Results Stats Service

17.1. Compliance Results Stats Service

17.1.1. GetComplianceClusterScanStats

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

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

17.1.1.1. Description

17.1.1.2. Parameters

17.1.1.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

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

17.1.1.3. Return Type

V2ListComplianceClusterScanStatsResponse

17.1.1.4. Content Type

application/json

17.1.1.5. Responses

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

17.1.1.6. Samples

17.1.2. GetComplianceClusterStats

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

17.1.2.1. Description

17.1.2.2. Parameters

17.1.2.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null

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

17.1.2.3. Return Type

V2ListComplianceClusterOverallStatsResponse

17.1.2.4. Content Type

application/json

17.1.2.5. Responses

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

17.1.2.6. Samples

17.1.3. GetComplianceOverallClusterStats

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

Deprecated in favor of GetComplianceClusterStats

17.1.3.1. Description

17.1.3.2. Parameters

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

17.1.3.3. Return Type

V2ListComplianceClusterOverallStatsResponse

17.1.3.4. Content Type

application/json

17.1.3.5. Responses

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

17.1.3.6. Samples

17.1.4. GetComplianceProfileCheckStats

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

GetComplianceProfileCheckStats lists current stats for a specific cluster check

17.1.4.1. Description

17.1.4.2. Parameters

17.1.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null
checkName		X	null

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

17.1.4.3. Return Type

V2ListComplianceProfileResults

17.1.4.4. Content Type

application/json

17.1.4.5. Responses

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

17.1.4.6. Samples

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

17.1.5.1. Description

17.1.5.2. Parameters

17.1.5.2.1. Path Parameters

Name	Description	Required	Default	Pattern
profileName		X	null

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

17.1.5.3. Return Type

V2ListComplianceProfileScanStatsResponse

17.1.5.4. Content Type

application/json

17.1.5.5. Responses

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

17.1.5.6. Samples

17.1.6. GetComplianceProfilesClusterStats

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

GetComplianceProfilesClusterStats lists cluster stats grouped by profile

17.1.6.1. Description

17.1.6.2. Parameters

17.1.6.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

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

17.1.6.3. Return Type

V2ListComplianceClusterProfileStatsResponse

17.1.6.4. Content Type

application/json

17.1.6.5. Responses

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

17.1.6.6. Samples

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

17.1.7.1. Description

17.1.7.2. Parameters

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

17.1.7.3. Return Type