GetReportConfigurations - ReportConfigurationService | API reference | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/report/configurations

Description

Parameters

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

Name

Description

Required

Default

Pattern

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

Return Type

V1GetReportConfigurationsResponse

Content Type

application/json

Responses

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

Samples

Common object reference

GooglerpcStatus

Field Name

Required

Nullable

Type

Description

Format

code

Integer

int32

message

String

details

List of ProtobufAny

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
@type			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.

@type

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.

ReportConfigurationReportType

Enum Values
VULNERABILITY

Enum Values

VULNERABILITY

ReportLastRunStatusRunStatus

Enum Values
SUCCESS
FAILURE

Enum Values

SUCCESS

FAILURE

ScheduleDaysOfMonth

1 for 1st, 2 for 2nd .... 31 for 31st

Field Name Required Nullable Type Description Format

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

days

List of integer

int32

ScheduleDaysOfWeek

Sunday = 0, Monday = 1, .... Saturday =  6

Field Name Required Nullable Type Description Format

Field Name	Required	Nullable	Type	Description	Format
days			List of `integer`		int32

days

List of integer

int32

ScheduleIntervalType

Enum Values
UNSET
DAILY
WEEKLY
MONTHLY

Enum Values

UNSET

DAILY

WEEKLY

MONTHLY

ScheduleWeeklyInterval

Field Name	Required	Nullable	Type	Description	Format
day			Integer		int32

Field Name

Required

Nullable

Type

Description

Format

day

Integer

int32

SimpleAccessScopeRules

Each element of any repeated field is an individual rule. Rules are joined by logical OR: if there exists a rule allowing resource x, x is in the access scope.

Field Name Required Nullable Type Description Format

includedClusters

List of string

includedNamespaces

List of SimpleAccessScopeRulesNamespace

clusterLabelSelectors

List of StorageSetBasedLabelSelector

namespaceLabelSelectors

List of StorageSetBasedLabelSelector

SimpleAccessScopeRulesNamespace

Field Name

Required

Nullable

Type

Description

Format

clusterName

String

Both fields must be set.

namespaceName

String

StorageEmailNotifierConfiguration

Field Name Required Nullable Type Description Format

notifierId

String

mailingLists

List of string

customSubject

String

customBody

String

StorageNotifierConfiguration

Field Name

Required

Nullable

Type

Description

Format

emailConfig

StorageEmailNotifierConfiguration

String

StorageReportConfiguration

Field Name

Required

Nullable

Type

Description

Format

String

name

String

description

String

type

ReportConfigurationReportType

VULNERABILITY,

vulnReportFilters

StorageVulnerabilityReportFilters

scopeId

String

emailConfig

StorageEmailNotifierConfiguration

schedule

StorageSchedule

lastRunStatus

StorageReportLastRunStatus

lastSuccessfulRunTime

Date

date-time

resourceScope

StorageResourceScope

notifiers

List of StorageNotifierConfiguration

creator

StorageSlimUser

version

Integer

int32

StorageReportLastRunStatus

Field Name

Required

Nullable

Type

Description

Format

reportStatus

ReportLastRunStatusRunStatus

SUCCESS, FAILURE,

lastRunTime

Date

date-time

errorMsg

String

StorageResourceScope

Field Name

Required

Nullable

Type

Description

Format

collectionId

String

StorageSchedule

Field Name

Required

Nullable

Type

Description

Format

intervalType

ScheduleIntervalType

UNSET, DAILY, WEEKLY, MONTHLY,

hour

Integer

int32

minute

Integer

int32

weekly

ScheduleWeeklyInterval

daysOfWeek

ScheduleDaysOfWeek

daysOfMonth

ScheduleDaysOfMonth

StorageSetBasedLabelSelector

SetBasedLabelSelector only allows set-based label requirements.

Next available tag: 3

Field Name

Required

Nullable

Type

Description

Format

requirements

List of StorageSetBasedLabelSelectorRequirement

StorageSetBasedLabelSelectorOperator

Enum Values
UNKNOWN
IN
NOT_IN
EXISTS
NOT_EXISTS

Enum Values

UNKNOWN

NOT_IN

EXISTS

NOT_EXISTS

StorageSetBasedLabelSelectorRequirement

Next available tag: 4

Field Name Required Nullable Type Description Format

key

String

StorageSetBasedLabelSelectorOperator

UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS,

values

List of string

StorageSlimUser

Field Name

Required

Nullable

Type

Description

Format

String

name

String

StorageVulnerabilityReportFilters

Field Name

Required

Nullable

Type

Description

Format

fixability

VulnerabilityReportFiltersFixability

BOTH, FIXABLE, NOT_FIXABLE,

sinceLastReport

Boolean

severities

List of StorageVulnerabilitySeverity

imageTypes

List of VulnerabilityReportFiltersImageType

allVuln

Boolean

sinceLastSentScheduledReport

Boolean

sinceStartDate

Date

date-time

accessScopeRules

List of SimpleAccessScopeRules

includeNvdCvss

Boolean

StorageVulnerabilitySeverity

Enum Values
UNKNOWN_VULNERABILITY_SEVERITY
LOW_VULNERABILITY_SEVERITY
MODERATE_VULNERABILITY_SEVERITY
IMPORTANT_VULNERABILITY_SEVERITY
CRITICAL_VULNERABILITY_SEVERITY

Enum Values

UNKNOWN_VULNERABILITY_SEVERITY

LOW_VULNERABILITY_SEVERITY

MODERATE_VULNERABILITY_SEVERITY

IMPORTANT_VULNERABILITY_SEVERITY

CRITICAL_VULNERABILITY_SEVERITY

V1GetReportConfigurationsResponse

Field Name

Required

Nullable

Type

Description

Format

reportConfigs

List of StorageReportConfiguration

VulnerabilityReportFiltersFixability

Enum Values
BOTH
FIXABLE
NOT_FIXABLE

Enum Values

BOTH

FIXABLE

NOT_FIXABLE

VulnerabilityReportFiltersImageType

Enum Values
DEPLOYED
WATCHED

Enum Values

DEPLOYED

WATCHED