Sign in
Event Gateway Backend Clusters

Create Backend Cluster

Creates a new backend cluster.

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

Request body

namestring required

The unique name of the backend cluster.

descriptionstring

A human-readable description of the backend cluster.

insecure_allow_anonymous_virtual_cluster_authboolean

If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities.

bootstrap_serversstring[] required

A list of cluster bootstrap servers in the format address:port.

metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

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": {
    "password": "${vault.env['MY_ENV_VAR']}"
  },
  "tls": {
    "client_identity": {
      "key": "${vault.env['MY_ENV_VAR']}"
    }
  },
  "labels": {
    "env": "test"
  }
}

Response

Created

idstring uuid required

The unique identifier of the backend cluster.

namestring required

The unique name of the backend cluster.

descriptionstring

A human-readable description of the backend cluster.

insecure_allow_anonymous_virtual_cluster_authboolean

If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities.

bootstrap_serversstring[] required

A list of cluster bootstrap servers in the format address:port.

metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

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": {
    "password": "${vault.env['MY_ENV_VAR']}"
  },
  "tls": {
    "client_identity": {
      "key": "${vault.env['MY_ENV_VAR']}"
    }
  },
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 6 of the 30 revisions of this API.10113

  • 658ffb748f9513See the full diff
    • ▲

      added BackendClusterAuthenticationSaslAwsIam to the authentication response property oneOf list for the response status 201

      response-property-one-of-added

    • ○

      added sasl_aws_iam discriminator mapping keys to the authentication request property

      request-property-discriminator-mapping-added

    • ○

      added BackendClusterAuthenticationSaslAwsIam to the authentication request property oneOf list

      request-property-one-of-added

    • ○

      added sasl_aws_iam discriminator mapping keys to the authentication response property for the response status 201

      response-property-discriminator-mapping-added

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

  • 106b373707f354See the full diff
    • ▲

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

      request-property-min-length-increased

    • ▲

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

      request-property-min-length-increased

    • ▲

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

      request-property-min-length-increased

    • ▲

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

      request-property-min-length-increased

    • ▲

      the tls/ca_bundle request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ○

      added the new optional request property tls/client_identity

      new-optional-request-property

    • ○

      the description request property default value was added

      request-property-default-value-added

    • ○

      added the optional property tls/client_identity to the response with the 201 status

      response-optional-property-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

  • 5d2b35832e3f113See the full diff
    • ▲

      added BackendClusterAuthenticationSaslPlainSensitiveDataAware BackendClusterAuthenticationSaslScramSensitiveDataAware to the authentication response property oneOf list for the response status 201

      response-property-one-of-added

    • ●

      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 BackendClusterAuthenticationSaslPlain to BackendClusterAuthenticationSaslPlainSensitiveDataAware for authentication response property for the response status 201

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key sasl_scram changed from BackendClusterAuthenticationSaslScram to BackendClusterAuthenticationSaslScramSensitiveDataAware for authentication response property for the response status 201

      response-property-discriminator-mapping-changed

    • ○

      removed BackendClusterAuthenticationSaslPlain BackendClusterAuthenticationSaslScram from the authentication response property oneOf list for the response status 201

      response-property-one-of-removed

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

  • 564d63b800a11See the full diff
    • ▲

      the request property description became not nullable

      request-property-became-not-nullable

  • 2724f73e1d4922See the full diff
    • ▲

      added the new required request property tls/enabled

      new-required-request-property

    • ▲

      the request property tls became required

      request-property-became-required

    • ○

      the response property tls became required for the status 201

      response-property-became-required

    • ○

      added the required property tls/enabled to the response with the 201 status

      response-required-property-added

  • ecce2daf9de61See the full diff
    • ○

      endpoint added

      endpoint-added