This is a cache of https://docs.openshift.com/acs/4.5/api/ConfigService.html. It is a snapshot of the page at 2024-11-25T18:11:16.547+0000.
ConfigS<strong>e</strong>rvic<strong>e</strong> | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | R<strong>e</strong>d Hat Advanc<strong>e</strong>d Clust<strong>e</strong>r S<strong>e</strong>curity for Kub<strong>e</strong>rn<strong>e</strong>t<strong>e</strong>s 4.5
&times;

GetConfig

GeT /v1/config

Description

Parameters

Return Type

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

StorageConfig

0

An unexpected error response.

Runtimeerror

Samples

GetPrivateConfig

GeT /v1/config/private

Description

Parameters

Return Type

Content Type

  • application/json

Responses

Table 2. HTTP Response Codes
Code Message Datatype

200

A successful response.

StoragePrivateConfig

0

An unexpected error response.

Runtimeerror

Samples

GetPublicConfig

GeT /v1/config/public

Description

Parameters

Return Type

Content Type

  • application/json

Responses

Table 3. HTTP Response Codes
Code Message Datatype

200

A successful response.

StoragePublicConfig

0

An unexpected error response.

Runtimeerror

Samples

GetVulnerabilityexceptionConfig

GeT /v1/config/private/exception/vulnerabilities

Description

Parameters

Content Type

  • application/json

Responses

Table 4. HTTP Response Codes
Code Message Datatype

200

A successful response.

V1GetVulnerabilityexceptionConfigResponse

0

An unexpected error response.

Runtimeerror

Samples

PutConfig

PUT /v1/config

Description

Parameters

Body Parameter

Name Description Required Default Pattern

body

V1PutConfigRequest

X

Return Type

Content Type

  • application/json

Responses

Table 5. HTTP Response Codes
Code Message Datatype

200

A successful response.

StorageConfig

0

An unexpected error response.

Runtimeerror

Samples

UpdateVulnerabilityexceptionConfig

PUT /v1/config/private/exception/vulnerabilities

Description

Parameters

Body Parameter

Name Description Required Default Pattern

body

V1UpdateVulnerabilityexceptionConfigRequest

X

Content Type

  • application/json

Responses

Table 6. HTTP Response Codes
Code Message Datatype

200

A successful response.

V1UpdateVulnerabilityexceptionConfigResponse

0

An unexpected error response.

Runtimeerror

Samples

Common object reference

BannerConfigSize

enum Values

UNSeT

SMALL

MeDIUM

LARGe

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

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

Runtimeerror

Field Name Required Nullable Type Description Format

error

String

code

Integer

int32

message

String

details

List of ProtobufAny

StorageAdministrationeventsConfig

Field Name Required Nullable Type Description Format

retentionDurationDays

Long

int64

StorageAlertRetentionConfig

Field Name Required Nullable Type Description Format

resolvedDeployRetentionDurationDays

Integer

int32

deletedRuntimeRetentionDurationDays

Integer

This runtime alert retention configuration takes precedence after allRuntimeRetentionDurationDays.

int32

allRuntimeRetentionDurationDays

Integer

This runtime alert retention configuration has highest precedence. All runtime alerts, including attempted alerts and deleted deployment alerts, are deleted even if respective retention is longer.

int32

attemptedDeployRetentionDurationDays

Integer

int32

attemptedRuntimeRetentionDurationDays

Integer

This runtime alert retention configuration has lowest precedence.

int32

StorageBannerConfig

Field Name Required Nullable Type Description Format

enabled

Boolean

text

String

size

BannerConfigSize

UNSeT, SMALL, MeDIUM, LARGe,

color

String

backgroundColor

String

StorageConfig

Field Name Required Nullable Type Description Format

publicConfig

StoragePublicConfig

privateConfig

StoragePrivateConfig

StorageDayOption

Field Name Required Nullable Type Description Format

numDays

Long

int64

enabled

Boolean

StorageDecommissionedClusterRetentionConfig

next available tag: 5
Field Name Required Nullable Type Description Format

retentionDurationDays

Integer

int32

ignoreClusterLabels

Map of string

lastUpdated

Date

date-time

createdAt

Date

date-time

StorageLoginNotice

Field Name Required Nullable Type Description Format

enabled

Boolean

text

String

StoragePrivateConfig

next available tag:9
Field Name Required Nullable Type Description Format

DePReCATeDAlertRetentionDurationDays

Integer

int32

alertConfig

StorageAlertRetentionConfig

imageRetentionDurationDays

Integer

int32

expiredVulnReqRetentionDurationDays

Integer

int32

decommissionedClusterRetention

StorageDecommissionedClusterRetentionConfig

reportRetentionConfig

StorageReportRetentionConfig

vulnerabilityexceptionConfig

StorageVulnerabilityexceptionConfig

administrationeventsConfig

StorageAdministrationeventsConfig

StoragePublicConfig

Field Name Required Nullable Type Description Format

loginNotice

StorageLoginNotice

header

StorageBannerConfig

footer

StorageBannerConfig

telemetry

StorageTelemetryConfiguration

StorageReportRetentionConfig

next available tag: 4
Field Name Required Nullable Type Description Format

historyRetentionDurationDays

Long

int64

downloadableReportRetentionDays

Long

int64

downloadableReportGlobalRetentionBytes

Long

int64

StorageTelemetryConfiguration

Field Name Required Nullable Type Description Format

enabled

Boolean

lastSetTime

Date

date-time

StorageVulnerabilityexceptionConfig

Field Name Required Nullable Type Description Format

expiryOptions

StorageVulnerabilityexceptionConfigexpiryOptions

StorageVulnerabilityexceptionConfigexpiryOptions

Field Name Required Nullable Type Description Format

dayOptions

List of StorageDayOption

fixableCveOptions

StorageVulnerabilityexceptionConfigFixableCVeOptions

customDate

Boolean

indefinite

Boolean

StorageVulnerabilityexceptionConfigFixableCVeOptions

Field Name Required Nullable Type Description Format

allFixable

Boolean

anyFixable

Boolean

V1DayOption

Field Name Required Nullable Type Description Format

numDays

Long

int64

enabled

Boolean

V1GetVulnerabilityexceptionConfigResponse

Field Name Required Nullable Type Description Format

config

V1VulnerabilityexceptionConfig

V1PutConfigRequest

Field Name Required Nullable Type Description Format

config

StorageConfig

V1UpdateVulnerabilityexceptionConfigRequest

Field Name Required Nullable Type Description Format

config

V1VulnerabilityexceptionConfig

V1UpdateVulnerabilityexceptionConfigResponse

Field Name Required Nullable Type Description Format

config

V1VulnerabilityexceptionConfig

V1VulnerabilityexceptionConfig

Field Name Required Nullable Type Description Format

expiryOptions

V1VulnerabilityexceptionConfigexpiryOptions

V1VulnerabilityexceptionConfigexpiryOptions

Field Name Required Nullable Type Description Format

dayOptions

List of V1DayOption

This allows users to set expiry interval based on number of days.

fixableCveOptions

V1VulnerabilityexceptionConfigFixableCVeOptions

customDate

Boolean

This option, if true, allows UI to show a custom date picker for setting expiry date.

indefinite

Boolean

V1VulnerabilityexceptionConfigFixableCVeOptions

Field Name Required Nullable Type Description Format

allFixable

Boolean

This options allows users to expire the vulnerability deferral request if and only if all vulnerabilities in the requests become fixable.

anyFixable

Boolean

This options allows users to expire the vulnerability deferral request if any vulnerability in the requests become fixable.