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

Chapter 15. Compliance Profile Service

15.1. Compliance Profile Service

15.1.1. GetComplianceProfile

GET /v2/compliance/profile/{id}

GetComplianceProfile retrieves the specified compliance profile

15.1.1.1. Description

15.1.1.2. Parameters

15.1.1.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

15.1.1.3. Return Type

V2ComplianceProfile

15.1.1.4. Content Type

application/json

15.1.1.5. Responses

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

15.1.1.6. Samples

15.1.2. ListComplianceProfiles

GET /v2/compliance/profiles/cluster

ListComplianceProfiles returns profiles matching given request

15.1.2.1. Description

15.1.2.2. Parameters

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

15.1.2.3. Return Type

V2ListComplianceProfilesResponse

15.1.2.4. Content Type

application/json

15.1.2.5. Responses

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

15.1.2.6. Samples

15.1.3. ListProfileSummaries

GET /v2/compliance/profiles/summary

ListProfileSummaries returns profiles matching each cluster and the given query

15.1.3.1. Description

15.1.3.2. Parameters

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

15.1.3.3. Return Type

V2ListComplianceProfileSummaryResponse

15.1.3.4. Content Type

application/json

15.1.3.5. Responses

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