How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kong

Kong Event Gateway Virtual Clusters API

Virtual clusters are the primary way clients interact with the Event Gateway proxy. They allow you to isolate clients from each other when connecting to the same backend cluster, and provide each client with modified view while still appearing as a standard Kafka cluster.

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

5 operations 2 paths 57 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://global.api.konghq.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
Kong Inc
License
Apache 2.0
Resource Areas
1

Authentication & Security 4

Kong Event Gateway Virtual Clusters API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Event Gateway Virtual Clusters 5

Virtual clusters are the primary way clients interact with the Event Gateway proxy. They allow you to isolate clients from each other when connecting to the same backend cluster,…

GET
/v1/event-gateways/{gatewayId}/virtual-clusters
List all virtual clusters
list-event-gateway-virtual-clusters 4 params → 200401403
POST
/v1/event-gateways/{gatewayId}/virtual-clusters
Create Virtual Cluster
create-event-gateway-virtual-cluster 1 param body → 201400401403
GET
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}
Get a Virtual Cluster
get-event-gateway-virtual-cluster 2 params → 200401403404
PUT
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}
Update Virtual Cluster
update-event-gateway-virtual-cluster 2 params body → 200400401403
DELETE
/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}
Delete Virtual Cluster
delete-event-gateway-virtual-cluster 2 params → 204401403404

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are VirtualCluster (12 properties), InvalidParameterDependentItem (5 properties), VirtualClusterAuthenticationOauthBearer (5 properties), InvalidParameterChoiceItem (5 properties). Each schema is shown below with its type and property counts.

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…
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
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
VirtualClusterAuthenticationPrincipalSensitiveDataAware
object
A principal for authentication.
2 properties 1 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…
VirtualClusterAuthenticationSensitiveDataAwareScheme
VirtualClusterAuthenticationOauthBearer
object
Oauth Bearer authentication scheme for the virtual cluster.
5 properties 2 required
StringFieldContainsFilter
object
Filters on the given string field value by fuzzy match.
1 property 1 required
InvalidParameterChoiceItem
object
5 properties 4 required
VirtualClusterNamespaceIdSelectorGlob
object
2 properties 2 required
VirtualClusterAuthenticationScheme
CursorMetaPage
object
5 properties 3 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
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…
BaseError
object
standard error
5 properties 4 required
BackendClusterReferenceByName
object
1 property 1 required
VirtualClusterNamespaceTopicSelectorGlob
object
3 properties 2 required
BackendClusterReference
object
The backend cluster associated with the virtual cluster.
2 properties 2 required
UnauthorizedError
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…
InvalidParameters
array
invalid parameters
VirtualClusterAuthenticationPrincipal
object
A principal for authentication containing username and password.
2 properties 2 required
BadRequestError
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…
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…
InvalidParameterMinimumLength
object
5 properties 4 required
VirtualClusterAuthenticationAnonymous
object
1 property 1 required
InvalidParameterDependentItem
object
5 properties 4 required
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
NotFoundError
VirtualClusterAuthenticationAudience
object
1 property 1 required
ForbiddenError
VirtualClusterNamespaceIdSelectorExactList
object
2 properties 1 required
VirtualClusterNamespaceIdSelector
object
1 required
VirtualClusterAuthenticationValidate
object
Validation rules.
2 properties
VirtualClusterAuthenticationClaimsMapping
object
Maps JWT claims in the case when sub and scope are presented as different claims in your JWT token.
2 properties
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,…
VirtualClusterNamespaceAdditionalProperties
object
2 properties
InvalidRules
string
invalid parameters rules
InvalidParameterMaximumLength
object
5 properties 4 required
BackendClusterReferenceById
object
1 property 1 required
VirtualClusterName
string
The name of the virtual cluster.
VirtualClusterAuthenticationSaslPlainSensitiveDataAware
object
SASL/PLAIN authentication scheme for the virtual cluster.
3 properties 2 required
CursorMeta
object
Pagination metadata.
1 property 1 required
VirtualClusterAuthenticationSaslPlain
object
SASL/PLAIN authentication scheme for the virtual cluster containing principals with username and password.
3 properties 2 required
VirtualClusterNamespaceTopicSelector
object
1 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…
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…
VirtualClusterNamespaceTopicSelectorExactList
object
3 properties 1 required
NamespaceExactAllowListItem
object
1 property 1 required
VirtualClusterAuthenticationSaslScram
object
SASL/SCRAM authentication scheme for the virtual cluster.
2 properties 2 required
VirtualCluster
object
A representation of a Kafka cluster that maps to a backend cluster.
12 properties 8 required
VirtualClusterAuthenticationClientCertificate
object
Client certificate (mTLS) authentication scheme for the virtual cluster. Requires a minimum runtime version of 1.1.
1 property 1 required
BackendClusterName
string
The unique name of the backend cluster.
InvalidParameterStandard
object
4 properties 2 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
VirtualClusterAuthenticationJWKS
object
JSON Web Key Set configuration for verifying token signatures.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-event-gateway-virtual-clusters-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
AE Profile APIs.io
Kong AI Gateway
AE Profile APIs.io
Kong Agent Gateway
AE Profile APIs.io
Kong MCP Registry
AE Profile APIs.io
Kong Context Mesh
AE Profile APIs.io
Kong Mesh
AE Profile APIs.io
Kong Insomnia
AE Profile APIs.io
Kong Add-Ons API
AE Profile APIs.io
Kong API Attributes API
AE Profile APIs.io
Kong API Documentation API
AE Profile APIs.io
Kong API Image API
AE Profile APIs.io
Kong API Implementation API
AE Profile APIs.io
#Event Gateway Virtual Clusters
← Back to K APIs
API Details
ID
kong:kong-event-gateway-virtual-clusters-api
Base URL
https://global.api.konghq.com
Docs
https://konghq.com/products/kong-gateway
Provider
Kong
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=kong-event-gateway-virtual-clusters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/kong-event-gateway-virtual-clusters-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Kong Event Gateway Virtual Clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.