ACLs7

Add-Ons5

AI Gateway Agents5

AI Gateway Auth Strategies5

AI Gateway CA Certificates5

AI Gateway Certificates5

AI Gateway Config Stores10

AI Gateway Consumer Groups8

AI Gateway Consumers11

AI Gateway DataPlane Certificates4

AI Gateway Identity Providers5

AI Gateway MCP Servers5

AI Gateway Model Providers5

AI Gateway Models5

AI Gateway Nodes3

AI Gateway Policies5

AI Gateway SNIs10

AI Gateway Vaults5

AI Gateways6

API6

API Attributes1

API Documentation6

API Image4

API Implementation4

API Operations2

API Package Documentation6

API Package Image4

API Package Operations4

API Package Specification4

API Packages5

API Publication8

API Specification6

API Version5

API-keys7

App Auth Strategies6

Application Registrations8

Applications8

Assets6

Auth Settings17

Authentication1

Basic-auth credentials7

CA Certificates5

Catalog Integrations1

Catalog Resource Mappings4

Catalog Resource Services1

Catalog Resources3

Catalog Service API Mappings5

Catalog Service Resources1

Catalog Services5

Certificates5

Cloud Gateways Resource Quotas3

Config Store Secrets5

Config Stores5

Consumer Groups9

Consumers9

Control Plane Groups6

Control Planes5

Criteria Templates1

Custom Domains5

Custom Plugin Schemas5

CustomPlugins5

Dashboards5

Data-Plane Group Configurations3

DCR Providers6

Degraphql_routes7

DP Certificates5

DP Nodes6

Event Gateway Backend Clusters5

Event Gateway DataPlane Certificates5

Event Gateway Listener Policies9

Event Gateway Listeners5

Event Gateway Nodes4

Event Gateway Schema Registries5

Event Gateway Static Keys4

Event Gateway TLS Trust Bundles5

Event Gateway Virtual Cluster Consume Policies9

Event Gateway Virtual Cluster Policies9

Event Gateway Virtual Cluster Produce Policies9

Event Gateway Virtual Clusters5

Event Gateways6

GraphQL Cost Decorations7

HMAC-auth credentials7

Impersonation Settings2

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances5

Invites1

JWTs7

Keys10

KeySets5

MCP Server Runtime1

MCP Servers6

Me2

Metering Events2

Meters6

MTLS-auth credentials7

Networks6

Notifications11

OpenMeter Apps2

OpenMeter Billing Settings5

OpenMeter Customers19

OpenMeter Defaults2

OpenMeter Entitlements1

OpenMeter Features6

OpenMeter LLM Cost5

OpenMeter Product Catalog19

OpenMeter Subscriptions8

OpenMeter Tax5

Pages7

Partial Links1

Partials5

Personal Access Tokens6

Plugins26

Portal Audit Logs6

Portal Auth Settings13

Portal Custom Domains4

Portal Customization3

Portal Developers5

Portal Emails19

Portal Integrations3

Portal Team Membership4

Portal Team Roles4

Portal Teams5

Portals5

Portals IP Allow List6

Private DNS5

Provider Accounts2

Resource Availability1

Resource Configurations3

Roles9

Routes10

Schemas2

Scorecards11

Services5

Skills2

Snippets5

SNIs10

System Accounts5

System Accounts - Access Tokens5

System Accounts - Roles4

System Accounts - Team Membership4

Targets6

Team Membership4

Teams5

Transit Gateways5

Upstreams5

Users4

Vaults5

Event Gateway Virtual Clusters

Create Virtual Cluster

Creates a new virtual cluster associated with the specified Event Gateway.

post/v1/event-gateways/{gatewayId}/virtual-clusters

Request body

namestring required

The name of the virtual cluster.

descriptionstring

A human-readable description of the virtual cluster.

acl_mode'enforce_on_gateway' | 'passthrough' required

Configures whether or not ACL policies are enforced on the gateway.

enforce_on_gateway means 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.
passthrough tells the gateway to forward all ACL-related commands.

dns_labelstring required

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.

labelsLabels

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 request

{
  "authentication": [
    {
      "principals": [
        {
          "password": "${vault.env['MY_ENV_VAR']}"
        }
      ]
    }
  ],
  "dns_label": "vcluster-1",
  "labels": {
    "env": "test"
  }
}

Response

Created

idstring uuid required

The unique identifier of the virtual cluster.

descriptionstring

A human-readable description of the virtual cluster.

namestring required

The name of the virtual cluster.

dns_labelstring required

acl_mode'enforce_on_gateway' | 'passthrough' required

Configures whether or not ACL policies are enforced on the gateway.

enforce_on_gateway means 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.
passthrough tells the gateway to forward all ACL-related commands.

labelsLabels

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 "_".

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "authentication": [
    {
      "principals": [
        {
          "password": "${vault.env['MY_ENV_VAR']}"
        }
      ]
    }
  ],
  "dns_label": "vcluster-1",
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 7 of the 75 revisions of this API.4218

Jun 30, 2026164458859caa8See the full diff
- ○
  added the new optional request property //////
  new-optional-request-property
- ○
  added the new optional request property //////
  new-optional-request-property
- ○
  added the new optional request property //////
  new-optional-request-property
- ○
  added the new optional request property //////
  new-optional-request-property
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 23, 2026bb5e056b7c6d22See the full diff
- ●
  removed the request property //
  request-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 5, 20269296070059c52See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
Mar 16, 2026377981ac9f1413See the full diff
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ○
  added client_certificate discriminator mapping keys to the / request property
  request-property-discriminator-mapping-added
- ○
  added to the / request property oneOf list
  request-property-one-of-added
- ○
  added client_certificate discriminator mapping keys to the / response property for the response status
  response-property-discriminator-mapping-added
Jan 20, 20267bc7400170e02See the full diff
- ○
  the request property default value was added
  request-property-default-value-added
- ○
  the response's property default value was added for the status
  response-property-default-value-added
Dec 22, 20255e6b2a1afead3See the full diff
- ▲
  the //////// request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the //////// request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the ///// request property's minLength was increased from 0 to 1
  request-property-min-length-increased
Dec 3, 2025581456e3279f1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history