Confluent

Confluent 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 on a cluster · List of Connectors #
Ask an LLM
“Which managed connectors are active on my Kafka cluster?”
“Can I get just the names of all running connectors in an environment?”
Tell an agent
List the connector names on cluster {kafka_cluster_id} in environment {environment_id}.
Show just the active connector names in environment {environment_id}, cluster {kafka_cluster_id}.
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 new fully managed connector on Confluent Cloud?”
“Can I set starting offsets when I create a connector?”
Tell an agent
Create connector {name} on cluster {kafka_cluster_id} in environment {environment_id} with config {config}.
Create connector {name} in {environment_id}/{kafka_cluster_id} 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 list connectors together with their status, info and IDs in one call?”
“Which of my connectors are failing, with status expanded for each?”
Tell an agent
List connectors in environment {environment_id}, cluster {kafka_cluster_id}, expanded with {expand}.
Show every connector with its status and info on cluster {kafka_cluster_id}, environment {environment_id}.
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 is a connector currently running with?”
“How do I see the config settings for one connector?”
Tell an agent
Get the configuration of connector {connector_name} in {environment_id}, cluster {kafka_cluster_id}.
Show connector {connector_name}'s config settings on cluster {kafka_cluster_id}, environment {environment_id}.
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 the settings of an existing connector without deleting it?”
“Which fields are required when I put a connector config, like connector class and API key?”
Tell an agent
Update connector {connector_name} config in {environment_id}/{kafka_cluster_id} to use class {connector_class}.
Create or replace connector {connector_name} config on {kafka_cluster_id} in {environment_id} with API key {api_key}.
GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name} Get information about one connector · Read a Connector #
Ask an LLM
“What type and tasks does a specific connector have?”
“Can I look up a single connector's details by name?”
Tell an agent
Get connector {connector_name} in environment {environment_id}, cluster {kafka_cluster_id}.
Show info about connector {connector_name} on cluster {kafka_cluster_id} in {environment_id}.
DELETE /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name} Delete a connector · Delete a Connector #
Ask an LLM
“How do I delete a connector and stop all its tasks?”
“Does deleting a connector also remove its configuration?”
Tell an agent destructive · confirm first
Delete connector {connector_name} from cluster {kafka_cluster_id} in {environment_id}.
Remove connector {connector_name} and halt its tasks in {environment_id}/{kafka_cluster_id}.

Documentation

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

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/json-schema/confluent-connect-v1-connector-with-offsets-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/json-schema/confluent-connect-v1-connector-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/json-schema/confluent-connect-v1-offsets-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/json-schema/confluent-connect-v1-connector-expansion-map-schema.json

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:confluent-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-connectors-connect-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent 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: 'Operations tagged Connectors (connect/v1) across 2 of this provider''s published API definitions: confluent-cloud-openapi.yaml, confluent-cloud-full.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.confluent.cloud
  description: Confluent Cloud API
tags:


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