Home
Products
Red Hat Advanced Cluster Security for Kubernetes
4.6
API reference
Chapter 56. Report Configuration Service

Chapter 56. Report Configuration Service

56.1. Report Configuration Service

56.1.1. CountReportConfigurations

GET /v1/report-configurations-count

CountReportConfigurations returns the number of report configurations.

56.1.1.1. Description

56.1.1.2. Parameters

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

56.1.1.3. Return Type

V1CountReportConfigurationsResponse

56.1.1.4. Content Type

application/json

56.1.1.5. Responses

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

56.1.1.6. Samples

56.1.2. DeleteReportConfiguration

DELETE /v1/report/configurations/{id}

DeleteReportConfiguration removes a report configuration given its id

56.1.2.1. Description

56.1.2.2. Parameters

56.1.2.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

56.1.2.3. Return Type

Object

56.1.2.4. Content Type

application/json

56.1.2.5. Responses

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

56.1.2.6. Samples

56.1.3. GetReportConfiguration

GET /v1/report/configurations/{id}

56.1.3.1. Description

56.1.3.2. Parameters

56.1.3.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

56.1.3.3. Return Type

V1GetReportConfigurationResponse

56.1.3.4. Content Type

application/json

56.1.3.5. Responses

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

56.1.3.6. Samples

56.1.4. GetReportConfigurations

GET /v1/report/configurations

56.1.4.1. Description

56.1.4.2. Parameters

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

56.1.4.3. Return Type

V1GetReportConfigurationsResponse

56.1.4.4. Content Type

application/json

56.1.4.5. Responses

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

56.1.4.6. Samples

56.1.5. PostReportConfiguration

POST /v1/report/configurations

PostReportConfiguration creates a report configuration

56.1.5.1. Description

56.1.5.2. Parameters

56.1.5.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V1PostReportConfigurationRequest	X

56.1.5.3. Return Type

V1PostReportConfigurationResponse

56.1.5.4. Content Type

application/json

56.1.5.5. Responses

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

56.1.5.6. Samples

56.1.6. UpdateReportConfiguration

PUT /v1/report/configurations/{id}

UpdateReportConfiguration updates a report configuration

56.1.6.1. Description

56.1.6.2. Parameters

56.1.6.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

56.1.6.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	ReportConfigurationServiceUpdateReportConfigurationBody	X

56.1.6.3. Return Type