MoveEventGatewayPolicy

object

Defines the position of a policy relative to the policy chain.

indexintegerrequired

The position of the policy relative to the policy chain.

>= 0

Example:2

Example

EventGatewayDataPlaneCertificate

object

A dataplane certificate.

idstring(uuid)required

The unique identifier of the certificate.

certificatestringrequired

JSON escaped string of the certificate.

namestring

The name to identify of the certificate.

>= 1 characters<= 255 characters

descriptionstring

A description of the certificate.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

metadataobject

Metadata extracted from a certificate.

Show Child Parameters
Example

CertificateMetadata

object

Metadata extracted from a certificate.

issuerstring

The issuer of the certificate.

subjectstring

The subject of the certificate.

key_usagesarray[string]

The key usages of the certificate.

expiryinteger(int64)

The expiry date of the certificate as a unix timestamp.

san_namesarray[string]

The Subject Alternative Names (SAN) of the certificate.

dns_namesarray[string]

The DNS names in the certificate SAN.

email_addressesarray[string]

The email addresses in the certificate SAN.

ip_addressesarray[string]

The IP addresses in the certificate SAN.

urisarray[string](uri)

The URIs in the certificate SAN.

sha256_fingerprintstring

The SHA-256 fingerprint of the certificate.

Example

EventGatewayNodeError

object

An error reported by an event gateway node.

namestringrequired

The name of the error.

messagestringrequired

The error message.

Example

VirtualClusterNamespace

object

Namespace allows to implement multitenancy using a single backend cluster.
It allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).

modestringrequired
  • hide_prefix - the configured prefix is hidden from clients for topics and IDs when reading.
    Created resources are written with the prefix on the backend cluster.
  • enforce_prefix - the configured prefix remains visible to clients.
    Created resources must include the prefix or the request will fail.

Allowed values:hide_prefixenforce_prefix

prefixstringrequired

The namespace is differentiated by this chosen prefix.
For example, if the prefix is set to “analytics_” the topic named “analytics_user_clicks” is available to the clients
of the virtual cluster. Topics without the prefix will be ignored unless added via additional.topics.

>= 1 characters

additionalobject
Show Child Parameters
Example