Home
Products
Red Hat Advanced Cluster Security for Kubernetes
4.6
API reference
Chapter 12. Collection Service

Chapter 12. Collection Service

12.1. Collection Service

12.1.1. CreateCollection

POST /v1/collections

12.1.1.1. Description

12.1.1.2. Parameters

12.1.1.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V1CreateCollectionRequest	X

12.1.1.3. Return Type

V1CreateCollectionResponse

12.1.1.4. Content Type

application/json

12.1.1.5. Responses

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

12.1.1.6. Samples

12.1.2. DeleteCollection

DELETE /v1/collections/{id}

12.1.2.1. Description

12.1.2.2. Parameters

12.1.2.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

12.1.2.3. Return Type

Object

12.1.2.4. Content Type

application/json

12.1.2.5. Responses

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

12.1.2.6. Samples

12.1.3. DryRunCollection

POST /v1/collections/dryrun

12.1.3.1. Description

12.1.3.2. Parameters

12.1.3.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V1DryRunCollectionRequest	X

12.1.3.3. Return Type

V1DryRunCollectionResponse

12.1.3.4. Content Type

application/json

12.1.3.5. Responses

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

12.1.3.6. Samples

12.1.4. GetCollection

GET /v1/collections/{id}

12.1.4.1. Description

12.1.4.2. Parameters

12.1.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

12.1.4.2.2. Query Parameters

Name	Description	Required	Default	Pattern
options.withMatches		-	null
options.filterQuery.query		-	null
options.filterQuery.pagination.limit		-	null
options.filterQuery.pagination.offset		-	null
options.filterQuery.pagination.sortOption.field		-	null
options.filterQuery.pagination.sortOption.reversed		-	null
options.filterQuery.pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
options.filterQuery.pagination.sortOption.aggregateBy.distinct		-	null

12.1.4.3. Return Type

V1GetCollectionResponse

12.1.4.4. Content Type

application/json

12.1.4.5. Responses

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

12.1.4.6. Samples

12.1.5. GetCollectionCount

GET /v1/collectionscount

12.1.5.1. Description

12.1.5.2. Parameters

12.1.5.2.1. Query Parameters

Name	Description	Required	Default	Pattern
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

12.1.5.3. Return Type

V1GetCollectionCountResponse

12.1.5.4. Content Type

application/json

12.1.5.5. Responses

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

12.1.5.6. Samples

12.1.6. ListCollectionSelectors

GET /v1/collections/selectors

12.1.6.1. Description

12.1.6.2. Parameters

12.1.6.3. Return Type

V1ListCollectionSelectorsResponse

12.1.6.4. Content Type

application/json

12.1.6.5. Responses

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

12.1.6.6. Samples

12.1.7. ListCollections

GET /v1/collections

12.1.7.1. Description

12.1.7.2. Parameters

12.1.7.2.1. Query Parameters

Name	Description	Required	Default	Pattern
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

12.1.7.3. Return Type

V1ListCollectionsResponse

12.1.7.4. Content Type

application/json

12.1.7.5. Responses

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

12.1.7.6. Samples

12.1.8. UpdateCollection

PATCH /v1/collections/{id}

12.1.8.1. Description

12.1.8.2. Parameters

12.1.8.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

12.1.8.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	CollectionServiceUpdateCollectionBody	X

12.1.8.3. Return Type

V1UpdateCollectionResponse

12.1.8.4. Content Type

application/json

12.1.8.5. Responses

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

12.1.8.6. Samples

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