Debezium

Debezium Offsets API

The Offsets API from Debezium — 1 operation(s) for offsets.

GitHub OpenAPI

Documentation

📖
Documentation
https://debezium.io/documentation/reference/stable/connectors/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/debezium/refs/heads/main/openapi/debezium-offsets-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/debezium/refs/heads/main/json-schema/debezium-change-event.json

Other Resources

🔗
Rules
https://raw.githubusercontent.com/api-evangelist/debezium/refs/heads/main/rules/debezium-kafka-connect-api-rules.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/debezium/refs/heads/main/capabilities/debezium-kafka-connect-api-capabilities.yml

OpenAPI Specification

debezium-offsets-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Debezium Kafka Connect REST Cluster Offsets API
  description: Debezium runs as connectors within Kafka Connect. This API provides endpoints for managing Debezium CDC connectors, their configurations, tasks, and offsets via the Kafka Connect REST interface.
  version: 2.6.0
  contact:
    name: Debezium
    url: https://debezium.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8083
  description: Default Kafka Connect worker running Debezium
tags:
- name: Offsets
paths:
  /connectors/{connector}/offsets:
    get:
      summary: Get connector offsets
      operationId: getConnectorOffsets
      tags:
      - Offsets
      parameters:
      - name: connector
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Connector offsets
          content:
            application/json:
              schema:
                type: object
                properties:
                  offsets:
                    type: array
                    items:
                      type: object
    patch:
      summary: Alter connector offsets
      operationId: alterOffsets
      tags:
      - Offsets
      parameters:
      - name: connector
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                offsets:
                  type: array
                  items:
                    type: object
      responses:
        '200':
          description: Offsets altered
    delete:
      summary: Reset connector offsets
      operationId: resetOffsets
      tags:
      - Offsets
      parameters:
      - name: connector
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Offsets reset