Kong Event Gateway Virtual Clusters API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Event Gateway Virtual Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes
5 operations
across 2 paths,
and defines 57 schemas.
It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
The identity and technical contract details declared by the specification.
VirtualClusterAuthenticationClaimsMapping
object
Maps JWT claims in the case when sub and scope are presented as different claims in your JWT token.
2 properties
InvalidParameterMinimumLength
object
5 properties
4 required
VirtualClusterTopicAlias
object
Pre-release Feature This feature is currently in beta and is subject to change. A topic alias maps an alias name to a namespace-visible topic name. Clients can…
4 properties
2 required
VirtualClusterTopicAliasConflict
string
How to handle conflicts where an alias shadows a physical topic. warn - activate the alias but log a warning and set the conflict metric to 1. ignore - activat…
VirtualClusterNamespaceTopicSelector
object
1 required
VirtualClusterAuthenticationValidate
object
Validation rules.
2 properties
VirtualClusterAuthenticationOauthBearer
object
Oauth Bearer authentication scheme for the virtual cluster.
5 properties
2 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties
4 required
NamespaceExactAllowListItem
object
1 property
1 required
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
VirtualClusterDNSLabel
string
The DNS label used in the bootstrap server URL to identify the virtual cluster when using SNI routing. The format follows the RFC1035: 1-63 chars, lowercase al…
InvalidParameterMaximumLength
object
5 properties
4 required
VirtualClusterAuthenticationPrincipal
object
A principal for authentication containing username and password.
2 properties
2 required
GatewaySecretReferenceOrLiteral
string
A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensiti…
BackendClusterReferenceByName
object
1 property
1 required
VirtualClusterAuthenticationSchemes
array
How to handle authentication from clients. It tries to authenticate with every rule sequentially one by one. It succeeds on the first match, and fails if no ru…
VirtualClusterAuthenticationSaslScram
object
SASL/SCRAM authentication scheme for the virtual cluster.
2 properties
2 required
Labels
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters,…
CursorMetaPage
object
5 properties
3 required
CursorMeta
object
Pagination metadata.
1 property
1 required
VirtualClusterNamespaceTopicSelectorExactList
object
3 properties
1 required
VirtualClusterAuthenticationAnonymous
object
1 property
1 required
BackendClusterReferenceById
object
1 property
1 required
VirtualClusterAuthenticationClientCertificate
object
Client certificate (mTLS) authentication scheme for the virtual cluster. Requires a minimum runtime version of 1.1.
1 property
1 required
VirtualClusterAuthenticationSensitiveDataAwareScheme
VirtualClusterNamespaceIdSelectorExactList
object
2 properties
1 required
VirtualClusterAuthenticationScheme
BackendClusterReference
object
The backend cluster associated with the virtual cluster.
2 properties
2 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties
4 required
InvalidParameterDependentItem
object
5 properties
4 required
BackendClusterName
string
The unique name of the backend cluster.
VirtualCluster
object
A representation of a Kafka cluster that maps to a backend cluster.
12 properties
8 required
InvalidRules
string
invalid parameters rules
BackendClusterReferenceModify
The backend cluster associated with the virtual cluster. Either id or name must be provided. Following changes to the backend cluster name won't affect the ref…
InvalidParameters
array
invalid parameters
VirtualClusterNamespaceIdSelectorGlob
object
2 properties
2 required
VirtualClusterAuthenticationSaslPlainSensitiveDataAware
object
SASL/PLAIN authentication scheme for the virtual cluster.
3 properties
2 required
InvalidParameterStandard
object
4 properties
2 required
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 g…
3 properties
2 required
GatewaySecret
string
A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at…
VirtualClusterAuthenticationJWKS
object
JSON Web Key Set configuration for verifying token signatures.
3 properties
1 required
VirtualClusterAuthenticationSaslPlain
object
SASL/PLAIN authentication scheme for the virtual cluster containing principals with username and password.
3 properties
2 required
VirtualClusterNamespaceAdditionalProperties
object
2 properties
VirtualClusterNamespaceIdSelector
object
1 required
VirtualClusterName
string
The name of the virtual cluster.
VirtualClusterAuthenticationSensitiveDataAwareSchemes
array
How to handle authentication from clients. It tries to authenticate with every rule sequentially one by one. It succeeds on the first match, and fails if no ru…
VirtualClusterNamespaceTopicSelectorGlob
object
3 properties
2 required
VirtualClusterACLMode
string
Configures whether or not ACL policies are enforced on the gateway. - enforceongateway means the gateway enforces its own ACL policies for this virtual cluster…
VirtualClusterAuthenticationAudience
object
1 property
1 required
VirtualClusterAuthenticationPrincipalSensitiveDataAware
object
A principal for authentication.
2 properties
1 required
StringFieldContainsFilter
object
Filters on the given string field value by fuzzy match.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kong publishes across the network.
