Sign in
Event Gateway Virtual Clusters

Get a Virtual Cluster

Returns information about a specific virtual cluster associated with the Event Gateway.

get/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}

Response

A single virtual cluster object.

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 5 of the 52 revisions of this API.27

  • 36da5cb9a6744See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property authentication/items/oneOf[VirtualClusterAuthenticationSaslScram]/fetch_kong_identity_principal to the response with the 200 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

  • 4a39c7f855091See the full diff
    • ▲

      the response property topic_aliases became nullable for the status 200

      response-property-became-nullable

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

  • 1f9c36d98f8d1See the full diff
    • ○

      added the optional property topic_aliases to the response with the 200 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

  • aad4daa45eee11See the full diff
    • ▲

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

      response-property-one-of-added

    • ○

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

      response-property-discriminator-mapping-added

  • 2b2a72c67bd21See the full diff
    • ○

      endpoint added

      endpoint-added