Event Gateway Virtual Clusters

Create Virtual Cluster

Changed on

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

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/event-gateways/{gatewayId}/virtual-clusters
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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

  • 7aab863a6daaRevision changes
    • breaking

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

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status