> ## Documentation Index
> Fetch the complete documentation index at: https://docs.restate.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Kafka cluster

> Returns the details of a specific Kafka cluster, including its configuration properties.
Sensitive properties (passwords, secrets, etc.) are automatically redacted in the response.



## OpenAPI

````yaml /schemas/openapi-admin.json get /kafka-clusters/{cluster_name}
openapi: 3.1.0
info:
  title: Admin API
  description: >-
    This API exposes the admin operations of a Restate cluster, such as
    registering new service deployments, interacting with running invocations,
    register Kafka subscriptions, retrieve service metadata. For an overview,
    check out the [Operate documentation](https://docs.restate.dev/operate/). If
    you're looking for how to call your services, check out the [Ingress HTTP
    API](https://docs.restate.dev/invoke/http) instead.
  contact:
    name: restate.dev
  license:
    name: MIT
    url: https://opensource.org/license/mit
  version: 1.7.2
servers: []
security: []
tags:
  - name: deployment
    description: Service Deployment management
  - name: invocation
    description: Invocation management
    externalDocs:
      url: https://docs.restate.dev/operate/invocation
      description: Invocations documentation
  - name: subscription
    description: Subscription management
    externalDocs:
      url: https://docs.restate.dev/operate/invocation#managing-kafka-subscriptions
      description: Kafka subscriptions documentation
  - name: kafka_cluster
    description: Kafka cluster management
  - name: service
    description: Service management
  - name: service_handler
    description: Service handlers metadata
  - name: cluster_health
    description: Cluster health
  - name: health
    description: Admin API health
  - name: version
    description: API Version
  - name: introspection
    description: System introspection
  - name: rule
    description: Limiter rule book management
externalDocs:
  url: https://docs.restate.dev/operate/
  description: Restate operations documentation
paths:
  /kafka-clusters/{cluster_name}:
    get:
      tags:
        - kafka_cluster
      summary: Get Kafka cluster
      description: >-
        Returns the details of a specific Kafka cluster, including its
        configuration properties.

        Sensitive properties (passwords, secrets, etc.) are automatically
        redacted in the response.
      operationId: get_kafka_cluster
      parameters:
        - name: cluster_name
          in: path
          description: Kafka cluster name
          required: true
          schema:
            type: string
        - name: include_subscriptions
          in: query
          description: If true, includes the list of subscriptions using this cluster.
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: Kafka cluster details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaClusterResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    KafkaClusterResponse:
      type: object
      description: Kafka cluster details with subscriptions.
      required:
        - name
        - properties
        - created_at
        - subscriptions
      properties:
        created_at:
          type: string
          description: |-
            # Created at

            When the Kafka cluster configuration was created.
        info:
          type: array
          items:
            $ref: '#/components/schemas/SchemaInfo'
          description: >-
            # Info


            List of configuration/deprecation information related to this
            deployment.
        name:
          $ref: '#/components/schemas/KafkaClusterName'
          description: >-
            # Cluster Name


            Name for the Kafka cluster, used to identify this Kafka cluster
            configuration in subscriptions. Must be a valid hostname format.
        properties:
          type: object
          description: >-
            # Properties


            Properties for connecting to the kafka cluster.


            For a full list of configuration properties, check the [librdkafka
            documentation](https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md).
          additionalProperties:
            type: string
          propertyNames:
            type: string
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionResponse'
          description: >-
            # Subscriptions


            Subscriptions to this Kafka cluster, returned only when
            `include_subscriptions` is enabled.
    SchemaInfo:
      type: object
      required:
        - message
      properties:
        code:
          type:
            - string
            - 'null'
        message:
          type: string
    KafkaClusterName:
      type: string
      format: hostname
      description: >-
        # Kafka cluster name


        Valid name to use as a kafka cluster identifier. MUST conform a valid
        hostname format.
    SubscriptionResponse:
      type: object
      description: Subscription details.
      required:
        - id
        - source
        - sink
        - options
      properties:
        id:
          $ref: '#/components/schemas/SubscriptionId'
        options:
          type: object
          additionalProperties:
            type: string
          propertyNames:
            type: string
        sink:
          type: string
        source:
          type: string
    ErrorDescriptionResponse:
      type: object
      description: |-
        # Error description response

        Error details of the response
      required:
        - message
      properties:
        message:
          type: string
        restate_code:
          type:
            - string
            - 'null'
          description: |-
            # Restate code

            Restate error code describing this error
    SubscriptionId:
      type: string
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorDescriptionResponse'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorDescriptionResponse'
    MethodNotAllowed:
      description: Method not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorDescriptionResponse'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorDescriptionResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorDescriptionResponse'

````