Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Kafka Connect

Kafka Connect Connectors API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Kafka Connect Connectors API is one of 3 APIs that Kafka Connect publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Connectors. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 14 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, http://localhost:8083.

19 operations 14 paths 0 schemas 2 DELETE8 GET1 PATCH3 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
http://localhost:8083
Resource Areas
1

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 2 DELETE, 8 GET, 1 PATCH, 3 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Connectors 19
GET
/connectors
List connectors
listConnectors 1 param → 200
POST
/connectors
Create connector
createConnector body → 201
GET
/connectors/{name}
Get connector
getConnector 1 param → 200
DELETE
/connectors/{name}
Delete connector
deleteConnector 1 param → 204
GET
/connectors/{name}/config
Get connector configuration
getConnectorConfig 1 param → 200
PUT
/connectors/{name}/config
Create or update connector configuration
putConnectorConfig 1 param body → 200
GET
/connectors/{name}/status
Get connector status
getConnectorStatus 1 param → 200
POST
/connectors/{name}/restart
Restart connector
restartConnector 3 params → 204
PUT
/connectors/{name}/pause
Pause connector
pauseConnector 1 param → 202
PUT
/connectors/{name}/resume
Resume connector
resumeConnector 1 param → 202
PUT
/connectors/{name}/stop
Stop connector
stopConnector 1 param → 204
GET
/connectors/{name}/tasks
List connector tasks
listConnectorTasks 1 param → 200
GET
/connectors/{name}/tasks/{taskid}/status
Get task status
getTaskStatus 2 params → 200
POST
/connectors/{name}/tasks/{taskid}/restart
Restart task
restartTask 2 params → 204
GET
/connectors/{name}/topics
Get connector topics
getConnectorTopics 1 param → 200
PUT
/connectors/{name}/topics/reset
Reset connector topics
resetConnectorTopics 1 param → 200
GET
/connectors/{connector}/offsets
Get connector offsets
getConnectorOffsets 1 param → 200
PATCH
/connectors/{connector}/offsets
Alter connector offsets
alterConnectorOffsets 1 param body → 200
DELETE
/connectors/{connector}/offsets
Reset connector offsets
deleteConnectorOffsets 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kafka-connect-connectors-api-openapi.yml Raw ↑

Other APIs Kafka Connect publishes across the network.

Kafka Connect Connector Plugins API
AE Profile APIs.io
Kafka Connect Kafka Connect REST API API
AE Profile APIs.io
#Connectors
← Back to K APIs
API Details
ID
kafka-connect:kafka-connect-connectors-api
Base URL
http://localhost:8083
Docs
https://kafka.apache.org/documentation/#connect_rest
Provider
Kafka Connect
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network