Create Virtual Cluster
Creates a new virtual cluster associated with the specified Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The request schema for creating a virtual cluster.
The name of the virtual cluster.
>= 1 characters<= 255 characters
A human-readable description of the virtual cluster.
Default:
<= 512 characters
Any OfThe 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
reference, as the system will create the entities relationship by id.
Show Child Parameters
One OfHow 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 rule matches.
>= 1 items
Show Child Parameters
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).
Show Child Parameters
Configures whether or not ACL policies are enforced on the gateway.
enforce_on_gatewaymeans the gateway enforces its own ACL policies for this virtual cluster
and does not forward ACL-related commands to the backend cluster.
Note that if there are no ACL policies configured, all access is denied.passthroughtells the gateway to forward all ACL-related commands.
Allowed values:enforce_on_gatewaypassthrough
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 alphanumeric or ‘-’, must start and end with an alphanumeric character.
Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
>= 1 characters<= 63 characters
Example:vcluster-1
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
Created
VirtualCluster
A representation of a Kafka cluster that maps to a backend cluster.
The unique identifier of the virtual cluster.
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The backend cluster associated with the virtual cluster.
Show Child Parameters
One OfHow 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 rule matches.
>= 1 items
Show Child Parameters
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).
Show Child Parameters
The name of the virtual cluster.
>= 1 characters<= 255 characters
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 alphanumeric or ‘-’, must start and end with an alphanumeric character.
Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
>= 1 characters<= 63 characters
Example:vcluster-1
Configures whether or not ACL policies are enforced on the gateway.
enforce_on_gatewaymeans the gateway enforces its own ACL policies for this virtual cluster
and does not forward ACL-related commands to the backend cluster.
Note that if there are no ACL policies configured, all access is denied.passthroughtells the gateway to forward all ACL-related commands.
Allowed values:enforce_on_gatewaypassthrough
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get a Virtual Cluster
Returns information about a specific virtual cluster associated with the Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
Response
application/json
Response
A single virtual cluster object.
VirtualCluster
A representation of a Kafka cluster that maps to a backend cluster.
The unique identifier of the virtual cluster.
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The backend cluster associated with the virtual cluster.
Show Child Parameters
One OfHow 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 rule matches.
>= 1 items
Show Child Parameters
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).
Show Child Parameters
The name of the virtual cluster.
>= 1 characters<= 255 characters
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 alphanumeric or ‘-’, must start and end with an alphanumeric character.
Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
>= 1 characters<= 63 characters
Example:vcluster-1
Configures whether or not ACL policies are enforced on the gateway.
enforce_on_gatewaymeans the gateway enforces its own ACL policies for this virtual cluster
and does not forward ACL-related commands to the backend cluster.
Note that if there are no ACL policies configured, all access is denied.passthroughtells the gateway to forward all ACL-related commands.
Allowed values:enforce_on_gatewaypassthrough
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Virtual Cluster
Updates an existing virtual cluster associated with the specified Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
Body
application/json
Body
The request schema for updating a virtual cluster.
The name of the virtual cluster.
>= 1 characters<= 255 characters
A human-readable description of the virtual cluster.
Default:
<= 512 characters
Any OfThe 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
reference, as the system will create the entities relationship by id.
Show Child Parameters
One OfHow 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 rule matches.
>= 1 items
Show Child Parameters
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).
Show Child Parameters
Configures whether or not ACL policies are enforced on the gateway.
enforce_on_gatewaymeans the gateway enforces its own ACL policies for this virtual cluster
and does not forward ACL-related commands to the backend cluster.
Note that if there are no ACL policies configured, all access is denied.passthroughtells the gateway to forward all ACL-related commands.
Allowed values:enforce_on_gatewaypassthrough
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 alphanumeric or ‘-’, must start and end with an alphanumeric character.
Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
>= 1 characters<= 63 characters
Example:vcluster-1
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
Updated virtual cluster object.
VirtualCluster
A representation of a Kafka cluster that maps to a backend cluster.
The unique identifier of the virtual cluster.
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The backend cluster associated with the virtual cluster.
Show Child Parameters
One OfHow 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 rule matches.
>= 1 items
Show Child Parameters
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).
Show Child Parameters
The name of the virtual cluster.
>= 1 characters<= 255 characters
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 alphanumeric or ‘-’, must start and end with an alphanumeric character.
Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
>= 1 characters<= 63 characters
Example:vcluster-1
Configures whether or not ACL policies are enforced on the gateway.
enforce_on_gatewaymeans the gateway enforces its own ACL policies for this virtual cluster
and does not forward ACL-related commands to the backend cluster.
Note that if there are no ACL policies configured, all access is denied.passthroughtells the gateway to forward all ACL-related commands.
Allowed values:enforce_on_gatewaypassthrough
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete Virtual Cluster
Deletes a specific virtual cluster associated with the Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Virtual Cluster.
Response
Response
No Content
Authentication
Path Parameters
Event Gateway Listeners
A listener represents hostname-port or IP-port combinations that connect to TCP sockets. Listeners need at least as many ports as backend brokers if you use port mapping in a Forward to Virtual Cluster policy. For SNI routing, you can route all brokers using a listener with only one port. Ports can be expressed as a single port or range. Addresses can be IPv4, IPv6, or hostnames.
A listener can have policies that enforce TLS certificates and perform SNI routing. The listener runs at Layer 4 of the network stack. In Kong Event Gateway, listeners first take in the connection and then route the TCP connection to a virtual cluster based on conditions defined in listener policies.