Soveren Kafka API

openapi: 3.1.0
info:
  title: Soveren Object Assets Kafka API
  version: v1
  description: 'The Soveren Object API exposes the data-security inventory Soveren discovers across your Kubernetes / cloud environment: clusters, assets (services and workloads), endpoints, detected data types, and the data flows between them, plus data-store inventories for S3, Kafka, and SQL databases. Read-only. Authenticate with a bearer token generated in the Soveren app under Integrations. This specification was reconstructed faithfully from Soveren''s published Object API reference (https://docs.soveren.io/en/stable/integration/api/ref/); response schemas are modeled as generic objects where the reference does not publish field-level detail.'
  x-apisjson-generated: '2026-07-21'
  x-apisjson-method: searched
  x-apisjson-source: https://docs.soveren.io/en/stable/integration/api/ref/
servers:
- url: https://api.soveren.io
  description: Soveren Object API production host
security:
- bearerAuth: []
tags:
- name: Kafka
paths:
  /api/v1/kafka/instances:
    get:
      operationId: list-kafka-instances
      summary: List Kafka instances
      tags:
      - Kafka
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          $ref: '#/components/responses/ObjectList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/kafka/instances/{id}:
    get:
      operationId: get-kafka-instance
      summary: Get a Kafka instance
      tags:
      - Kafka
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Object'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/kafka/topics:
    get:
      operationId: list-kafka-topics
      summary: List Kafka topics
      tags:
      - Kafka
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - name: instance_id
        in: query
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/ObjectList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/kafka/topics/{id}:
    get:
      operationId: get-kafka-topic
      summary: Get a Kafka topic
      tags:
      - Kafka
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Object'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Missing or invalid bearer token.
    Object:
      description: A single object.
      content:
        application/json:
          schema:
            type: object
    NotFound:
      description: The requested object was not found.
    ObjectList:
      description: A paginated list of objects.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  type: object
  parameters:
    offset:
      name: offset
      in: query
      description: Number of items to skip for pagination.
      schema:
        type: integer
    limit:
      name: limit
      in: query
      description: Maximum number of items to return.
      schema:
        type: integer
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token generated in the Soveren app under Integrations - External API.