Kafka Connect Connectors API

openapi: 3.1.0
info:
  title: Kafka Connect REST Connector Plugins Connectors API
  description: Minimal OpenAPI 3.1 description of the Apache Kafka Connect REST API for managing connectors, tasks, plugins, offsets, and topics.
  version: 1.0.0
servers:
- url: http://localhost:8083
  description: Local Kafka Connect worker
tags:
- name: Connectors
paths:
  /connectors:
    get:
      summary: List connectors
      operationId: listConnectors
      parameters:
      - name: expand
        in: query
        schema:
          type: string
          enum:
          - status
          - info
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      tags:
      - Connectors
    post:
      summary: Create connector
      operationId: createConnector
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Created
      tags:
      - Connectors
  /connectors/{name}:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get connector
      operationId: getConnector
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Connectors
    delete:
      summary: Delete connector
      operationId: deleteConnector
      responses:
        '204':
          description: Deleted
      tags:
      - Connectors
  /connectors/{name}/config:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get connector configuration
      operationId: getConnectorConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Connectors
    put:
      summary: Create or update connector configuration
      operationId: putConnectorConfig
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
      tags:
      - Connectors
  /connectors/{name}/status:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get connector status
      operationId: getConnectorStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Connectors
  /connectors/{name}/restart:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Restart connector
      operationId: restartConnector
      parameters:
      - name: includeTasks
        in: query
        schema:
          type: boolean
      - name: onlyFailed
        in: query
        schema:
          type: boolean
      responses:
        '204':
          description: Restarted
      tags:
      - Connectors
  /connectors/{name}/pause:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    put:
      summary: Pause connector
      operationId: pauseConnector
      responses:
        '202':
          description: Accepted
      tags:
      - Connectors
  /connectors/{name}/resume:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    put:
      summary: Resume connector
      operationId: resumeConnector
      responses:
        '202':
          description: Accepted
      tags:
      - Connectors
  /connectors/{name}/stop:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    put:
      summary: Stop connector
      operationId: stopConnector
      responses:
        '204':
          description: Stopped
      tags:
      - Connectors
  /connectors/{name}/tasks:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: List connector tasks
      operationId: listConnectorTasks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      tags:
      - Connectors
  /connectors/{name}/tasks/{taskid}/status:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    - name: taskid
      in: path
      required: true
      schema:
        type: integer
    get:
      summary: Get task status
      operationId: getTaskStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Connectors
  /connectors/{name}/tasks/{taskid}/restart:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    - name: taskid
      in: path
      required: true
      schema:
        type: integer
    post:
      summary: Restart task
      operationId: restartTask
      responses:
        '204':
          description: Restarted
      tags:
      - Connectors
  /connectors/{name}/topics:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get connector topics
      operationId: getConnectorTopics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Connectors
  /connectors/{name}/topics/reset:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    put:
      summary: Reset connector topics
      operationId: resetConnectorTopics
      responses:
        '200':
          description: OK
      tags:
      - Connectors
  /connectors/{connector}/offsets:
    parameters:
    - name: connector
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get connector offsets
      operationId: getConnectorOffsets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Connectors
    patch:
      summary: Alter connector offsets
      operationId: alterConnectorOffsets
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
      tags:
      - Connectors
    delete:
      summary: Reset connector offsets
      operationId: deleteConnectorOffsets
      responses:
        '200':
          description: OK
      tags:
      - Connectors
x-generated-from: https://kafka.apache.org/documentation/#connect_rest
x-generated-by: claude-crawl-2026-05-08