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

Chapter 20. Compliance Service

20.1. Compliance Service
Copy link

20.1.1. GetAggregatedResults
Copy link

GET /v1/compliance/aggregatedresults

20.1.1.1. Description
Copy link

20.1.1.2. Parameters
Copy link

20.1.1.2.1. Query Parameters
Copy link

Expand

Name	Description	Required	Default	Pattern
groupBy	`String`	-	null
unit		-	UNKNOWN
where.query		-	null
where.pagination.limit		-	null
where.pagination.offset		-	null
where.pagination.sortOption.field		-	null
where.pagination.sortOption.reversed		-	null
where.pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
where.pagination.sortOption.aggregateBy.distinct		-	null

20.1.1.3. Return Type
Copy link

StorageComplianceAggregationResponse

20.1.1.4. Content Type
Copy link

application/json

20.1.1.5. Responses
Copy link

Expand

Table 20.1. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	StorageComplianceAggregationResponse
0	An unexpected error response.	GooglerpcStatus

20.1.1.6. Samples
Copy link

20.1.2. GetRunResults
Copy link

GET /v1/compliance/runresults

20.1.2.1. Description
Copy link

20.1.2.2. Parameters
Copy link

20.1.2.2.1. Query Parameters
Copy link

Expand

Name	Description	Required	Default	Pattern
clusterId		-	null
standardId		-	null
runId	Specifies the run ID for which to return results. If empty, the most recent run is returned. CAVEAT: Setting this field circumvents the results cache on the server-side, which may lead to significantly increased memory pressure and decreased performance.	-	null

20.1.2.3. Return Type
Copy link

V1GetComplianceRunResultsResponse

20.1.2.4. Content Type
Copy link

application/json

20.1.2.5. Responses
Copy link

Expand

Table 20.2. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetComplianceRunResultsResponse
0	An unexpected error response.	GooglerpcStatus

20.1.2.6. Samples
Copy link

20.1.3. GetStandard
Copy link

GET /v1/compliance/standards/{id}

20.1.3.1. Description
Copy link

20.1.3.2. Parameters
Copy link

20.1.3.2.1. Path Parameters
Copy link

Expand

Name	Description	Required	Default	Pattern
id		X	null

20.1.3.3. Return Type
Copy link

V1GetComplianceStandardResponse

20.1.3.4. Content Type
Copy link

application/json

20.1.3.5. Responses
Copy link

Expand

Table 20.3. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetComplianceStandardResponse
0	An unexpected error response.	GooglerpcStatus

20.1.3.6. Samples
Copy link

20.1.4. GetStandards
Copy link

GET /v1/compliance/standards

20.1.4.1. Description
Copy link

20.1.4.2. Parameters
Copy link

20.1.4.3. Return Type
Copy link

V1GetComplianceStandardsResponse

20.1.4.4. Content Type
Copy link

application/json

20.1.4.5. Responses
Copy link

Expand

Table 20.4. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetComplianceStandardsResponse
0	An unexpected error response.	GooglerpcStatus

20.1.4.6. Samples
Copy link

20.1.5. UpdateComplianceStandardConfig
Copy link

PATCH /v1/compliance/standards/{id}

20.1.5.1. Description
Copy link

20.1.5.2. Parameters
Copy link

20.1.5.2.1. Path Parameters
Copy link

Expand

Name	Description	Required	Default	Pattern
id		X	null

20.1.5.2.2. Body Parameter
Copy link

Expand

Name	Description	Required	Default	Pattern
body	ComplianceServiceUpdateComplianceStandardConfigBody	X

20.1.5.3. Return Type
Copy link

Object

20.1.5.4. Content Type
Copy link

application/json

20.1.5.5. Responses
Copy link

Expand

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

20.1.5.6. Samples
Copy link

Back to top

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat