---
title: "BackendCluster"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/schemas/BackendCluster"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19.md

# BackendCluster

The Kafka cluster.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for Event Gateways
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    BackendClusterName:
      description: The unique name of the backend cluster.
      type: string
      maxLength: 255
      minLength: 1
      x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
    BackendClusterAuthenticationSensitiveDataAwareScheme:
      discriminator:
        propertyName: type
        mapping:
          anonymous: "#/components/schemas/BackendClusterAuthenticationAnonymous"
          sasl_plain: "#/components/schemas/BackendClusterAuthenticationSaslPlainSensitiv\
            eDataAware"
          sasl_scram: "#/components/schemas/BackendClusterAuthenticationSaslScramSensitiv\
            eDataAware"
      oneOf:
        - $ref: "#/components/schemas/BackendClusterAuthenticationAnonymous"
        - $ref: "#/components/schemas/BackendClusterAuthenticationSaslPlainSensitiveDataA\
            ware"
        - $ref: "#/components/schemas/BackendClusterAuthenticationSaslScramSensitiveDataA\
            ware"
    BootstrapServers:
      description: A list of cluster bootstrap servers in the format address:port.
      type: array
      items:
        type: string
        description: Endpoint in address:port format.
        pattern: ^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$
        minLength: 1
      minItems: 1
    BackendClusterTLS:
      type: object
      properties:
        enabled:
          description: If true, TLS is enabled for connections to this backend cluster. If
            false, TLS is explicitly disabled.
          type: boolean
        insecure_skip_verify:
          description: If true, skip certificate verification. It's not secure to use for
            production.
          type: boolean
          default: false
        ca_bundle:
          $ref: "#/components/schemas/GatewaySecretReferenceOrLiteral"
        tls_versions:
          description: List of supported TLS versions.
          type: array
          items:
            type: string
            enum:
              - tls12
              - tls13
          default:
            - tls12
            - tls13
        client_identity:
          description: |-
            Client mTLS configuration.

            **Requires a minimum runtime version of `1.1`**.
          type: object
          properties:
            certificate:
              $ref: "#/components/schemas/GatewaySecretReferenceOrLiteral"
            key:
              $ref: "#/components/schemas/GatewaySecret"
          required:
            - certificate
            - key
          x-min-runtime-version: "1.1"
          x-speakeasy-param-computed: false
      required:
        - enabled
    BackendMetadataUpdateIntervalSeconds:
      description: The interval at which metadata is updated in seconds.
      type: integer
      default: 60
      maximum: 43200
      minimum: 1
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BackendClusterAuthenticationAnonymous:
      description: Anonymous authentication scheme for the backend cluster.
      type: object
      properties:
        type:
          description: The type of authentication scheme.
          type: string
          enum:
            - anonymous
          x-terraform-transform-const: true
      additionalProperties: false
      required:
        - type
    BackendClusterAuthenticationSaslPlainSensitiveDataAware:
      description: >
        SASL/PLAIN authentication scheme for the backend cluster without
        requiring sensitive password data.
      type: object
      properties:
        type:
          type: string
          enum:
            - sasl_plain
          x-terraform-transform-const: true
        username:
          $ref: "#/components/schemas/GatewaySecretReferenceOrLiteral"
        password:
          $ref: "#/components/schemas/GatewaySecret"
      additionalProperties: false
      required:
        - type
        - username
    BackendClusterAuthenticationSaslScramSensitiveDataAware:
      description: >
        SASL/SCRAM authentication scheme for the backend cluster without
        requiring sensitive password data.
      type: object
      properties:
        type:
          type: string
          enum:
            - sasl_scram
          x-terraform-transform-const: true
        algorithm:
          description: The algorithm used for SASL/SCRAM authentication.
          type: string
          enum:
            - sha256
            - sha512
        username:
          $ref: "#/components/schemas/GatewaySecretReferenceOrLiteral"
        password:
          $ref: "#/components/schemas/GatewaySecret"
      additionalProperties: false
      required:
        - type
        - username
        - algorithm
    GatewaySecretReferenceOrLiteral:
      description: >
        A literal value or a reference to an existing secret as a template
        string expression.

        The value is stored and returned by the API as-is, not treated as
        sensitive information.
      type: string
      minLength: 1
      x-examples:
        reference:
          summary: Reference to a secret
          value: ${vault.env['MY_ENV_VAR']}
        literal:
          summary: Literal value
          value: my-literal-value
      x-expression:
        type: string
        fields:
          - vault
    GatewaySecret:
      description: >
        A sensitive value containing the secret or a reference to a secret as a
        template string expression.

        If the value is provided as plain text, it is encrypted at rest and
        omitted from API responses.

        If provided as an expression, the expression itself is stored and
        returned by the API.
      type: string
      example: ${vault.env['MY_ENV_VAR']}
      minLength: 1
      x-expression:
        type: string
        fields:
          - vault
      x-sensitive: true
    BackendCluster:
      description: The Kafka cluster.
      type: object
      properties:
        id:
          description: The unique identifier of the backend cluster.
          type: string
          format: uuid
          readOnly: true
        name:
          $ref: "#/components/schemas/BackendClusterName"
        description:
          description: A human-readable description of the backend cluster.
          type: string
          default: ""
          maxLength: 512
        authentication:
          $ref: "#/components/schemas/BackendClusterAuthenticationSensitiveDataAwareSchem\
            e"
        insecure_allow_anonymous_virtual_cluster_auth:
          description: >
            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.
          type: boolean
          default: false
        bootstrap_servers:
          $ref: "#/components/schemas/BootstrapServers"
        tls:
          $ref: "#/components/schemas/BackendClusterTLS"
        metadata_update_interval_seconds:
          $ref: "#/components/schemas/BackendMetadataUpdateIntervalSeconds"
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - authentication
        - bootstrap_servers
        - tls
        - created_at
        - updated_at
```
