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 7 of the 30 revisions of this API.2123

  • 73b05fbfd2ef11See the full diff
    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 55d91b8ceecd5See the full diff
    • ○

      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

    • ○

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

  • 2322191a98f711See 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 / response property for the response status

      response-property-discriminator-mapping-added

  • 106b373707f31See the full diff
    • ○

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

      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

  • 5d2b35832e3f15See the full diff
    • ▲

      added to the / response property oneOf list for the response status

      response-property-one-of-added

    • ○

      mapped value for discriminator key sasl_plain changed from to for / response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      removed from the / response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      the //////// response's property pattern ^[A-Za-z0-9._?*-]+$ was added for the status

      response-property-pattern-added

    • ○

      the //////// response's property pattern ^[A-Za-z0-9._?*-]+$ was added for the status

      response-property-pattern-added

    • ○

      the 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

      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

  • be46646a0f0a9See the full diff
    • ○

      the response property const value exact_list was added for the status

      response-property-const-added

    • ○

      the response property const value exact_list was added for the status

      response-property-const-added

    • ○

      the response property const value glob was added for the status

      response-property-const-added

    • ○

      the response property const value glob was added for the status

      response-property-const-added

    • ○

      removed the exact_list enum value from the //////// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the exact_list enum value from the //////// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the glob enum value from the //////// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the glob enum value from the //////// response property for the response status

      response-property-enum-value-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

  • ecce2daf9de61See the full diff
    • ○

      endpoint added

      endpoint-added