Kong · Schema

BackendCluster

The Kafka cluster.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string The unique identifier of the backend cluster.
name object
description string A human-readable description of the backend cluster.
authentication object
insecure_allow_anonymous_virtual_cluster_auth boolean 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_servers object
tls object
metadata_update_interval_seconds object
labels object
created_at object
updated_at object
View JSON Schema on GitHub

JSON Schema

kong-backendcluster-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BackendCluster",
  "title": "BackendCluster",
  "description": "The Kafka cluster.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier of the backend cluster.",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "x-speakeasy-param-suppress-computed-diff": 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/BackendClusterAuthenticationSensitiveDataAwareScheme"
    },
    "insecure_allow_anonymous_virtual_cluster_auth": {
      "description": "If true, virtual clusters can have allow anonymous authentication and use this backend cluster.\nThis setting is not recommended for production use as it may create privilege escalation vulnerabilities.\n",
      "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"
  ]
}