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

GetCentralCapabilities

GET /v1/central-capabilities

Description

Parameters

Return Type

V1CentralServicesCapabilities

Content Type

application/json

Responses

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

Samples

GetDatabaseBackupStatus

GET /v1/backup/status

Description

Parameters

Return Type

V1DatabaseBackupStatus

Content Type

application/json

Responses

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

Samples

GetDatabaseStatus

GET /v1/database/status

Description

Parameters

Return Type

V1DatabaseStatus

Content Type

application/json

Responses

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

Samples

GetMetadata

GET /v1/metadata

Description

Parameters

Return Type

V1Metadata

Content Type

application/json

Responses

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

Samples

TLSChallenge

GET /v1/tls-challenge

TLSChallenge

Description

Returns all trusted CAs, i.e., secret/additional-ca and Central’s cert chain. This is necessary if Central is running behind a load balancer with self-signed certificates. Does not require authentication.

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
challengeToken	generated challenge token by the service asking for TLS certs.	-	null

Name

Description

Required

Default

Pattern

challengeToken

generated challenge token by the service asking for TLS certs.

null

Return Type

V1TLSChallengeResponse

Content Type

application/json

Responses

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

Samples

Common object reference

CentralServicesCapabilitiesCapabilityStatus

CapabilityAvailable: CapabilityAvailable means that UI and APIs should be available for users to use. This does not automatically mean that the functionality is 100% available and any calls to APIs will result in successful execution. Rather it means that users should be allowed to leverage the functionality as opposed to CapabilityDisabled when functionality should be blocked.
CapabilityDisabled: CapabilityDisabled means the corresponding UI should be disabled and attempts to use related APIs should lead to errors.

Enum Values
CapabilityAvailable
CapabilityDisabled

Enum Values

CapabilityAvailable

CapabilityDisabled

DatabaseStatusDatabaseType

Enum Values
Hidden
RocksDB
PostgresDB

Enum Values

Hidden

RocksDB

PostgresDB

MetadataLicenseStatus

Enum Values

NONE

INVALID

EXPIRED

RESTARTING

VALID

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

RuntimeError

Field Name

Required

Nullable

Type

Description

Format

error

String

code

Integer

int32

message

String

details

List of ProtobufAny

StorageBackupInfo

Field Name

Required

Nullable

Type

Description

Format

backupLastRunAt

Date

date-time

status

StorageOperationStatus

FAIL, PASS,

requestor

StorageSlimUser

StorageOperationStatus

Enum Values
FAIL
PASS

Enum Values

FAIL

PASS

StorageSlimUser

Field Name

Required

Nullable

Type

Description

Format

String

name

String

V1CentralServicesCapabilities

Provides availability of certain functionality of Central Services in the current configuration. The initial intended use is to disable certain functionality that does not make sense in the Cloud Service context.

Field Name	Type	Format
centralScanningCanUseContainerIamRoleForEcr	CentralServicesCapabilitiesCapabilityStatus	CapabilityAvailable, CapabilityDisabled,
centralCanUseCloudBackupIntegrations	CentralServicesCapabilitiesCapabilityStatus	CapabilityAvailable, CapabilityDisabled,
centralCanDisplayDeclarativeConfigHealth	CentralServicesCapabilitiesCapabilityStatus	CapabilityAvailable, CapabilityDisabled,
centralCanUpdateCert	CentralServicesCapabilitiesCapabilityStatus	CapabilityAvailable, CapabilityDisabled,
centralCanUseAcscsEmailIntegration	CentralServicesCapabilitiesCapabilityStatus	CapabilityAvailable, CapabilityDisabled,

Field Name

Required

Nullable

Type

Description

Format

centralScanningCanUseContainerIamRoleForEcr

CentralServicesCapabilitiesCapabilityStatus