Kafka Connect

Kafka Connect Connectors API

The Connectors API from Kafka Connect — 14 operation(s) for connectors.

GitHub OpenAPI

Operations 19

GET /connectors List connectors #
POST /connectors Create connector #
GET /connectors/{name} Get connector #
DELETE /connectors/{name} Delete connector #
GET /connectors/{name}/config Get connector configuration #
PUT /connectors/{name}/config Create or update connector configuration #
GET /connectors/{name}/status Get connector status #
POST /connectors/{name}/restart Restart connector #
PUT /connectors/{name}/pause Pause connector #
PUT /connectors/{name}/resume Resume connector #
PUT /connectors/{name}/stop Stop connector #
GET /connectors/{name}/tasks List connector tasks #
GET /connectors/{name}/tasks/{taskid}/status Get task status #
POST /connectors/{name}/tasks/{taskid}/restart Restart task #
GET /connectors/{name}/topics Get connector topics #
PUT /connectors/{name}/topics/reset Reset connector topics #
GET /connectors/{connector}/offsets Get connector offsets #
PATCH /connectors/{connector}/offsets Alter connector offsets #
DELETE /connectors/{connector}/offsets Reset connector offsets #

Documentation

📖
Documentation
https://kafka.apache.org/documentation/#connect_rest

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kafka-connect/refs/heads/main/openapi/kafka-connect-connectors-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/kafka-connect-connectors-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kafka-connect-connectors-api-openapi.yml Raw ↑ 
openapi: 3.2.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