CollectionService | API reference | Red Hat Advanced Cluster Security for Kubernetes 4.5

CreateCollection

POST /v1/collections

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	V1CreateCollectionRequest	X

Name

Description

Required

Default

Pattern

body

V1CreateCollectionRequest

Return Type

V1CreateCollectionResponse

Content Type

application/json

Responses

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

Samples

DeleteCollection

DELETE /v1/collections/{id}

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Name

Description

Required

Default

Pattern

null

Return Type

Object

Content Type

application/json

Responses

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

Samples

DryRunCollection

POST /v1/collections/dryrun

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	V1DryRunCollectionRequest	X

Name

Description

Required

Default

Pattern

body

V1DryRunCollectionRequest

Return Type

V1DryRunCollectionResponse

Content Type

application/json

Responses

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

Samples

GetCollection

GET /v1/collections/{id}

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Name

Description

Required

Default

Pattern

null

Query Parameters

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

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

Return Type

V1GetCollectionResponse

Content Type

application/json

Responses

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

Samples

GetCollectionCount

GET /v1/collectionscount

Description

Parameters

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

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

Return Type

V1GetCollectionCountResponse

Content Type

application/json

Responses

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

Samples

ListCollectionSelectors

GET /v1/collections/selectors

Description

Parameters

Return Type

V1ListCollectionSelectorsResponse

Content Type

application/json

Responses

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

Samples

ListCollections

GET /v1/collections

Description

Parameters

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

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

Return Type

V1ListCollectionsResponse

Content Type

application/json

Responses

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

Samples

UpdateCollection

PATCH /v1/collections/{id}

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Name

Description

Required

Default

Pattern

null

Body Parameter

Name	Description	Required	Default	Pattern
body	V1UpdateCollectionRequest	X

Name

Description

Required

Default

Pattern

body

V1UpdateCollectionRequest

Return Type

V1UpdateCollectionResponse

Content Type

application/json

Responses

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

Samples

Common object reference

ProtobufAny

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON representation

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Field Name Required Nullable Type Description Format

Field Name	Required	Nullable	Type	Description	Format
typeUrl			String	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value			byte[]	Must be a valid serialized protocol buffer of the above specified type.	byte

typeUrl

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

value

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

ResourceCollectionEmbeddedResourceCollection

Field Name

Required

Nullable

Type

Description

Format

String

RuntimeError

Field Name

Required

Nullable

Type

Description

Format

error

String

code

Integer

int32

message

String

details

List of ProtobufAny

StorageBooleanOperator

Enum Values
OR
AND

Enum Values

AND

StorageListDeployment

Next available tag: 9

Field Name

Required

Nullable

Type

Description

Format

String

hash

String

uint64

name

String

cluster

String

clusterId

String

namespace

String

created

Date

date-time

priority

String

int64

StorageMatchType

Enum Values
EXACT
REGEX

Enum Values

EXACT

REGEX

StorageResourceCollection

Field Name Required Nullable Type Description Format

String

name

String

description

String

createdAt

Date

date-time

lastUpdated

Date

date-time

createdBy

StorageSlimUser

updatedBy

StorageSlimUser

resourceSelectors

List of StorageResourceSelector

resource_selectors resolve as disjunction (OR) with each-other and with selectors from embedded_collections. For MVP, the size of resource_selectors will at most be 1 from UX standpoint.

embeddedCollections

List of ResourceCollectionEmbeddedResourceCollection

StorageResourceSelector

Field Name Required Nullable Type Description Format

Field Name	Required	Nullable	Type	Description	Format
rules			List of StorageSelectorRule	`rules` resolve as a conjunction (AND).

rules

List of StorageSelectorRule

rules resolve as a conjunction (AND).

StorageRuleValue

Field Name

Required

Nullable

Type

Description

Format

value

String

matchType

StorageMatchType

EXACT, REGEX,

StorageSelectorRule

Field Name Required Nullable Type Description Format

fieldName

String

operator

StorageBooleanOperator

OR, AND,

values

List of StorageRuleValue

values resolve as a conjunction (AND) or disjunction (OR) depending on operator. For MVP, only OR is supported from UX standpoint.

StorageSlimUser

Field Name

Required

Nullable

Type

Description

Format

String

name

String

V1AggregateBy

Field Name

Required

Nullable

Type

Description

Format

aggrFunc

V1Aggregation

UNSET, COUNT, MIN, MAX,

distinct

Boolean

V1Aggregation

Enum Values
UNSET
COUNT
MIN
MAX

Enum Values

UNSET

COUNT

MIN

MAX

V1CollectionDeploymentMatchOptions

Field Name

Required

Nullable

Type

Description

Format

withMatches

Boolean

filterQuery

V1RawQuery

V1CreateCollectionRequest

Field Name Required Nullable Type Description Format

name

String

description

String

resourceSelectors

List of StorageResourceSelector

embeddedCollectionIds

List of string

V1CreateCollectionResponse

Field Name

Required

Nullable

Type

Description

Format

collection

StorageResourceCollection

V1DryRunCollectionRequest

Field Name Required Nullable Type Description Format

name

String

description

String

resourceSelectors

List of StorageResourceSelector

embeddedCollectionIds

List of string

options

V1CollectionDeploymentMatchOptions

V1DryRunCollectionResponse

Field Name

Required

Nullable

Type

Description

Format

deployments

List of StorageListDeployment

V1GetCollectionCountResponse

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32

Field Name

Required

Nullable

Type

Description

Format

count

Integer

int32

V1GetCollectionResponse

Field Name

Required

Nullable

Type

Description

Format

collection

StorageResourceCollection

deployments

List of StorageListDeployment

V1ListCollectionSelectorsResponse

Field Name Required Nullable Type Description Format

selectors

List of string

V1ListCollectionsResponse

Field Name

Required

Nullable

Type

Description

Format

collections

List of StorageResourceCollection

V1Pagination

Field Name

Required

Nullable

Type

Description

Format

limit

Integer

int32

offset

Integer

int32

sortOption

V1SortOption

sortOptions

List of V1SortOption

This field is under development. It is not supported on any REST APIs.

V1RawQuery

RawQuery represents the search query string. The format of the query string is "<field name>:<value,value,…><field name>:<value, value,...>…" For example: To search for deployments named "central" and "sensor" in the namespace "stackrox", the query string would be "Deployment:central,sensor+Namespace:stackrox" RawQuery is used in ListAPIs to search for a particular object.

Field Name

Required

Nullable

Type

Description

Format

query

String

pagination

V1Pagination

V1SortOption

Field Name

Required

Nullable

Type

Description

Format

field

String

reversed

Boolean

aggregateBy

V1AggregateBy

V1UpdateCollectionRequest

Field Name Required Nullable Type Description Format

String

name

String

description

String

resourceSelectors

List of StorageResourceSelector

embeddedCollectionIds

List of string

V1UpdateCollectionResponse

Field Name

Required

Nullable

Type

Description

Format

collection

StorageResourceCollection