Confluent | the Data Streaming Platform

Confluent | the Data Streaming Platform Connectors (connect/v1) API

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) API for Managed Connectors or Custom Connectors in Confluent Cloud. The API allows you to list, create, get, update and delete a Managed Connector or Custom Connector in Confluent Cloud. Connect metrics are available through the [Metrics v2 API](https://api.telemetry.confluent.cloud/docs#tag/Version-2). Related guide: [Confluent Cloud API and Managed Connectors](https://docs.confluent.io/cloud/current/connectors/connect-api-section.html).

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors List connector names in a Kafka cluster · List of Connectors #
Ask an LLM
“Which managed connectors are active on my Kafka cluster?”
“Can I get just the names of the connectors running in an environment?”
Tell an agent
List the connector names on cluster {cluster} in environment {environment}.
Show me which connectors are active in {cluster}.
POST /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors Create a managed connector · Create a Connector #
Ask an LLM
“How do I create a fully managed connector on Confluent Cloud?”
“Can I set starting offsets when creating a new connector?”
Tell an agent
Create a connector named {name} on cluster {cluster} in {environment} with config {config}.
Launch new connector {name} in {cluster} starting from offsets {offsets}.
GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id List connectors with status and details · List of Connectors with Expansions #
Ask an LLM
“Can I get the status and config of every connector in one call?”
“Which of my connectors are failing, without reading each one separately?”
Tell an agent
List all connectors on {cluster} in {environment} expanded with {expand}.
Show the status and info of every connector in cluster {cluster}.
GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config Read a connector's configuration · Read a Connector Configuration #
Ask an LLM
“What configuration settings is a connector currently running with?”
“Where can I see the config properties of one connector?”
Tell an agent
Get the configuration of connector {connector} on cluster {cluster} in {environment}.
Show me the config map for {connector}.
PUT /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config Create or update a connector's configuration · Create or Update a Connector Configuration #
Ask an LLM
“Can I change a connector's configuration in place without deleting it?”
“Which fields are required when putting a connector config, like the connector class and Kafka API key?”
Tell an agent
Set the config of connector {connector} on {cluster} in {environment} to class {class}.
Update {connector} to authenticate with Kafka API key {api_key} and secret {api_secret}.
GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name} Read a connector's details · Read a Connector #
Ask an LLM
“What type and tasks does a specific connector have?”
“Can I look up one connector's information by name?”
Tell an agent
Get connector {connector} on cluster {cluster} in {environment}.
Show details about the {connector} connector.
DELETE /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name} Delete a connector · Delete a Connector #
Ask an LLM
“What happens to running tasks when I delete a connector?”
“Can I remove a connector and its configuration completely?”
Tell an agent destructive · confirm first
Delete connector {connector} from cluster {cluster} in {environment}.
Remove the {connector} connector and halt its tasks.

Documentation

📖
Documentation
https://docs.confluent.io/cloud/current/api.html
📖
APIReference
https://docs.confluent.io/cloud/current/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-connectors-connect-v1-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/mcp/confluent-the-data-streaming-platform-tool-crosswalk.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/data-model/confluent-the-data-streaming-platform-data-model.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/confluent-the-data-streaming-platform:confluent-the-data-streaming-platform-connectors-connect-v1-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

confluent-the-data-streaming-platform-connectors-connect-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Cloud Connectors (connect/v1) API
  version: ''
  x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b
  x-audience: external-public
  x-logo:
    url: https://assets.confluent.io/m/1661ef5e4ff82d3d/
  description: '# Introduction


    Note


    This documents the collection of Confluent Cloud APIs.'
servers:
- url: https://api.confluent.cloud
  description: Confluent Cloud API
tags:


# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-connectors-connect-v1-api-openapi.yml