Sign in
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

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.

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 8 of the 29 revisions of this API.21532

  • 73b05fbfd2ef22See the full diff
    • ●

      removed the request property topic_aliases/items/match

      request-property-removed

    • ●

      removed the optional property topic_aliases/items/match from the response with the 201 status

      response-optional-property-removed

    • ○

      added the new optional request property topic_aliases/items/condition

      new-optional-request-property

    • ○

      added the optional property topic_aliases/items/condition to the response with the 201 status

      response-optional-property-added

  • 55d91b8ceecd10See the full diff
    • ○

      added the new optional request property authentication/items/oneOf[VirtualClusterAuthenticationClientCertificate]/fetch_kong_identity_principal

      new-optional-request-property

    • ○

      added the new optional request property authentication/items/oneOf[VirtualClusterAuthenticationOauthBearer]/fetch_kong_identity_principal

      new-optional-request-property

    • ○

      added the new optional request property authentication/items/oneOf[VirtualClusterAuthenticationSaslPlain]/fetch_kong_identity_principal

      new-optional-request-property

    • ○

      added the new optional request property authentication/items/oneOf[VirtualClusterAuthenticationSaslScram]/fetch_kong_identity_principal

      new-optional-request-property

    • ○

      added the new optional request property topic_aliases

      new-optional-request-property

    • ○

      added the optional property authentication/items/oneOf[VirtualClusterAuthenticationClientCertificate]/fetch_kong_identity_principal to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property authentication/items/oneOf[VirtualClusterAuthenticationOauthBearer]/fetch_kong_identity_principal to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property authentication/items/oneOf[VirtualClusterAuthenticationSaslPlainSensitiveDataAware]/fetch_kong_identity_principal to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property authentication/items/oneOf[VirtualClusterAuthenticationSaslScram]/fetch_kong_identity_principal to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property topic_aliases to the response with the 201 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2322191a98f713See the full diff
    • ▲

      added VirtualClusterAuthenticationClientCertificate to the authentication/items/ response property oneOf list for the response status 201

      response-property-one-of-added

    • ○

      added client_certificate discriminator mapping keys to the authentication/items/ request property

      request-property-discriminator-mapping-added

    • ○

      added VirtualClusterAuthenticationClientCertificate to the authentication/items/ request property oneOf list

      request-property-one-of-added

    • ○

      added client_certificate discriminator mapping keys to the authentication/items/ response property for the response status 201

      response-property-discriminator-mapping-added

  • 106b373707f322See the full diff
    • ▲

      the authentication/items/oneOf[VirtualClusterAuthenticationSaslPlain]/principals/items/password request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the authentication/items/oneOf[VirtualClusterAuthenticationSaslPlain]/principals/items/username request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ○

      the description request property default value was added

      request-property-default-value-added

    • ○

      the description response's property default value was added for the status 201

      response-property-default-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5d2b35832e3f625See the full diff
    • ▲

      the request property authentication/items/oneOf[VirtualClusterAuthenticationSaslPlain]/principals/items/password became required

      request-property-became-required

    • ▲

      the request property authentication/items/oneOf[VirtualClusterAuthenticationSaslPlain]/principals/items/username became required

      request-property-became-required

    • ▲

      the authentication/items/oneOf[VirtualClusterAuthenticationSaslPlain]/principals request property's minItems was increased to 1

      request-property-min-items-increased

    • ▲

      added the pattern ^[A-Za-z0-9._?*-]+$ to the request property namespace/additional/consumer_groups/items/oneOf[VirtualClusterNamespaceIdSelectorGlob]/glob

      request-property-pattern-added

    • ▲

      added the pattern ^[A-Za-z0-9._?*-]+$ to the request property namespace/additional/topics/items/oneOf[VirtualClusterNamespaceTopicSelectorGlob]/glob

      request-property-pattern-added

    • ▲

      added VirtualClusterAuthenticationSaslPlainSensitiveDataAware to the authentication/items/ response property oneOf list for the response status 201

      response-property-one-of-added

    • ●

      changed the pattern of the request property dns_label from ^[a-z]([-a-z0-9]*[a-z0-9])?$ to ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

      request-property-pattern-changed

    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    • ○

      mapped value for discriminator key sasl_plain changed from VirtualClusterAuthenticationSaslPlain to VirtualClusterAuthenticationSaslPlainSensitiveDataAware for authentication/items/ response property for the response status 201

      response-property-discriminator-mapping-changed

    • ○

      removed VirtualClusterAuthenticationSaslPlain from the authentication/items/ response property oneOf list for the response status 201

      response-property-one-of-removed

    • ○

      the namespace/additional/consumer_groups/items/oneOf[VirtualClusterNamespaceIdSelectorGlob]/glob response's property pattern ^[A-Za-z0-9._?*-]+$ was added for the status 201

      response-property-pattern-added

    • ○

      the namespace/additional/topics/items/oneOf[VirtualClusterNamespaceTopicSelectorGlob]/glob response's property pattern ^[A-Za-z0-9._?*-]+$ was added for the status 201

      response-property-pattern-added

    • ○

      the dns_label response's property pattern was changed from ^[a-z]([-a-z0-9]*[a-z0-9])?$ to ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ for the status 201

      response-property-pattern-changed

    This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 564d63b800a13See the full diff
    • ▲

      the request property description became not nullable

      request-property-became-not-nullable

    • ▲

      the request property namespace/additional/consumer_groups became not nullable

      request-property-became-not-nullable

    • ▲

      the request property namespace/additional/topics became not nullable

      request-property-became-not-nullable

  • be46646a0f0a919See the full diff
    • ▲

      added the new required request property acl_mode

      new-required-request-property

    • ▲

      the type request property const value exact_list was added

      request-property-const-added

    • ▲

      the type request property const value exact_list was added

      request-property-const-added

    • ▲

      the type request property const value glob was added

      request-property-const-added

    • ▲

      the type request property const value glob was added

      request-property-const-added

    • ▲

      removed the enum value exact_list of the request property namespace/additional/consumer_groups/items/oneOf[VirtualClusterNamespaceIdSelectorExactList]/type

      request-property-enum-value-removed

    • ▲

      removed the enum value exact_list of the request property namespace/additional/topics/items/oneOf[VirtualClusterNamespaceTopicSelectorExactList]/type

      request-property-enum-value-removed

    • ▲

      removed the enum value glob of the request property namespace/additional/consumer_groups/items/oneOf[VirtualClusterNamespaceIdSelectorGlob]/type

      request-property-enum-value-removed

    • ▲

      removed the enum value glob of the request property namespace/additional/topics/items/oneOf[VirtualClusterNamespaceTopicSelectorGlob]/type

      request-property-enum-value-removed

    • ●

      removed the request property destination/name

      request-property-removed

    • ○

      the type response property const value exact_list was added for the status 201

      response-property-const-added

    • ○

      the type response property const value exact_list was added for the status 201

      response-property-const-added

    • ○

      the type response property const value glob was added for the status 201

      response-property-const-added

    • ○

      the type response property const value glob was added for the status 201

      response-property-const-added

    • ○

      removed the exact_list enum value from the namespace/additional/consumer_groups/items/oneOf[VirtualClusterNamespaceIdSelectorExactList]/type response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the exact_list enum value from the namespace/additional/topics/items/oneOf[VirtualClusterNamespaceTopicSelectorExactList]/type response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the glob enum value from the namespace/additional/consumer_groups/items/oneOf[VirtualClusterNamespaceIdSelectorGlob]/type response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the glob enum value from the namespace/additional/topics/items/oneOf[VirtualClusterNamespaceTopicSelectorGlob]/type response property for the response status 201

      response-property-enum-value-removed

    • ○

      added the required property acl_mode to the response with the 201 status

      response-required-property-added

  • ecce2daf9de61See the full diff
    • ○

      endpoint added

      endpoint-added