Conduktor Clusters API

openapi: 3.0.1
info:
  title: Conduktor Certificates Clusters API
  description: Unified specification of the Conduktor REST API surface, covering the Conduktor Console API (clusters, certificates, users, groups, RBAC permissions, and declarative Self-Service resources) and the Conduktor Gateway API (interceptors, virtual clusters, service accounts, and tokens). Console endpoints authenticate with an admin-generated Bearer API key; Gateway admin endpoints authenticate with Basic auth. Host names are deployment-specific.
  termsOfService: https://www.conduktor.io/terms-and-conditions/
  contact:
    name: Conduktor Support
    url: https://www.conduktor.io/contact/
  version: '1.0'
servers:
- url: https://{consoleHost}
  description: Conduktor Console deployment host
  variables:
    consoleHost:
      default: localhost:8080
      description: Host and port of your Conduktor Console deployment
- url: https://{gatewayAdminHost}:8888
  description: Conduktor Gateway admin API host
  variables:
    gatewayAdminHost:
      default: localhost
      description: Host of your Conduktor Gateway admin endpoint
tags:
- name: Clusters
  description: Manage Kafka cluster registrations in Console
paths:
  /public/v1/configs/{cluster}/clusters:
    get:
      operationId: listClusters
      tags:
      - Clusters
      summary: List configured Kafka clusters
      security:
      - bearerAuth: []
      responses:
        '200':
          description: A list of cluster configurations.
          content:
            application/yaml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KafkaCluster'
  /public/v1/clusters:
    get:
      operationId: getClusters
      tags:
      - Clusters
      summary: List registered Kafka clusters
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Registered clusters.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KafkaCluster'
    post:
      operationId: upsertCluster
      tags:
      - Clusters
      summary: Create or update a Kafka cluster registration
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KafkaCluster'
      responses:
        '200':
          description: Cluster created or updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaCluster'
  /public/v1/clusters/{cluster}:
    delete:
      operationId: deleteCluster
      tags:
      - Clusters
      summary: Delete a Kafka cluster registration
      security:
      - bearerAuth: []
      parameters:
      - name: cluster
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Cluster deleted.
components:
  schemas:
    KafkaCluster:
      type: object
      properties:
        apiVersion:
          type: string
          example: v1
        kind:
          type: string
          example: KafkaCluster
        metadata:
          type: object
          properties:
            name:
              type: string
        spec:
          type: object
          properties:
            displayName:
              type: string
            bootstrapServers:
              type: string
            color:
              type: string
            ignoreUntrustedCertificate:
              type: boolean
            properties:
              type: object
              additionalProperties:
                type: string
            schemaRegistry:
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Console API key generated by an admin in Settings > API Keys, passed as Authorization: Bearer $ADMIN_API_KEY.'
    basicAuth:
      type: http
      scheme: basic
      description: Gateway admin credentials (GATEWAY_ADMIN_API_USERS), passed as HTTP Basic authentication to the Gateway admin API.