[](#section/Versioning/API-Lifecycle-Policy) API for requesting the status or the tasks for a Managed Connector or Custom Connector in Confluent Cloud.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/confluent-status-connect-v1-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Confluent Cloud Status (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:
- name: Status (connect/v1)
description: '
API for requesting the status or the tasks for a Managed Connector or Custom Connector in Confluent Cloud.'
paths:
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status:
x-lifecycle-stage: General Availability
parameters:
- name: connector_name
in: path
schema:
type: string
required: true
description: The unique name of the connector.
- name: environment_id
in: path
schema:
type: string
required: true
description: The unique identifier of the environment this resource belongs to.
- name: kafka_cluster_id
in: path
schema:
type: string
required: true
description: The unique identifier for the Kafka cluster.
get:
x-lifecycle-stage: General Availability
operationId: readConnectv1ConnectorStatus
description: Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks.
summary: Read a Connector Status
tags:
- Status (connect/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: Connector.
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the connector.
type:
type: string
description: Type of connector, sink or source.
enum:
- sink
- source
connector:
type: object
description: The map containing connector status.
required:
- state
- worker_id
properties:
state:
type: string
description: The state of the connector.
enum:
- NONE
- PROVISIONING
- RUNNING
- DEGRADED
- FAILED
- PAUSED
- DELETED
worker_id:
type: string
description: The worker ID of the connector.
trace:
type: string
description: The exception name in case of error.
tasks:
type: array
description: The map containing the task status.
items:
type: object
properties:
id:
type: integer
description: The ID of task.
state:
type: string
description: The state of the task.
worker_id:
type: string
description: The worker ID of the task.
msg:
type: string
required:
- id
- state
- worker_id
required:
- name
- type
- connector
example:
name: MyGcsLogsBucketConnector
connector:
state: PROVISIONING
worker_id: MyGcsLogsBucketConnector
trace: ''
tasks: []
type: source
'401':
$ref: '#/components/responses/connect.v1.UnauthenticatedError'
'404':
$ref: '#/components/responses/connect.v1.AccountNotFoundError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/connect.v1.DefaultSystemError'
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks:
x-lifecycle-stage: General Availability
parameters:
- name: connector_name
in: path
schema:
type: string
required: true
description: The unique name of the connector.
- name: environment_id
in: path
schema:
type: string
required: true
description: The unique identifier of the environment this resource belongs to.
- name: kafka_cluster_id
in: path
schema:
type: string
required: true
description: The unique identifier for the Kafka cluster.
get:
x-lifecycle-stage: General Availability
operationId: listConnectv1ConnectorTasks
description: '
Get a list of tasks currently running for the connector.'
summary: List of Connector Tasks
tags:
- Status (connect/v1)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: Connector Task.
content:
application/json:
schema:
$ref: '#/components/schemas/connect.v1.Connectors'
example:
- id:
connector: MyGcsLogsBucketConnector
task: 2
config:
cloud.environment: prod
cloud.provider: aws
connector.class: GcsSink
data.format: BYTES
flush.size: '1000'
gcs.bucket.name: APILogsBucket
gcs.credentials.config: '****************'
kafka.api.key: '****************'
kafka.api.secret: '****************'
kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092
kafka.region: us-west-2
name: MyGcsLogsBucketConnector
tasks.max: '2'
time.interval: DAILY
topics: APILogsTopic
'401':
$ref: '#/components/responses/connect.v1.UnauthenticatedError'
'404':
$ref: '#/components/responses/connect.v1.AccountNotFoundError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/connect.v1.DefaultSystemError'
components:
schemas:
connect.v1.ConnectorError:
type: object
properties:
error:
type: object
description: Connector Error with error code and message.
properties:
code:
type: integer
description: Error code for the type of error
message:
type: string
description: Human readable error message
connect.v1.Connectors:
type: array
description: List of active task configs that have been created by the connector
items:
type: object
properties:
id:
type: object
description: The ID of task.
properties:
connector:
type: string
description: The name of the connector the task belongs to.
task:
type: integer
description: Task ID within the connector.
config:
type: object
description: "Configuration parameters for the connector. These configurations\nare the minimum set of key-value pairs (KVP) which can be used to\ndefine how the connector connects Kafka to the external system.\nSome of these KVPs are common to all the connectors, such as\nconnection parameters to Kafka, connector metadata, etc. The list\nof common connector configurations is as follows\n\n - cloud.environment\n - cloud.provider\n - connector.class\n - kafka.api.key\n - kafka.api.secret\n - kafka.endpoint\n - kafka.region\n - name\n\nA specific connector such as `GcsSink` would have additional\nparameters such as `gcs.bucket.name`, `flush.size`, etc."
required:
- cloud.environment
- cloud.provider
- connector.class
- name
- kafka.endpoint
- kafka.region
- kafka.api.key
- kafka.api.secret
properties:
cloud.environment:
type: string
description: The cloud environment type.
cloud.provider:
type: string
description: The cloud service provider, e.g. aws, azure, etc.
x-extensible-enum:
- aws
- azure
- gcp
connector.class:
type: string
description: The connector class name. E.g. BigQuerySink, GcsSink, etc.
name:
type: string
description: Name or alias of the class (plugin) for this connector.
kafka.endpoint:
type: string
description: The kafka cluster endpoint.
kafka.region:
type: string
description: The kafka cluster region.
kafka.api.key:
type: string
description: The kafka cluster api key.
kafka.api.secret:
type: string
description: The kafka cluster api secret key.
x-redact: true
additionalProperties:
type: string
responses:
RateLimitError:
description: Rate Limit Exceeded
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
X-RateLimit-Limit:
schema:
type: integer
description: The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining in the current rate limit window.
X-RateLimit-Reset:
schema:
type: integer
description: "The relative time in seconds until the current rate-limit window resets. \n \n**Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues."
Retry-After:
schema:
type: integer
description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
connect.v1.AccountNotFoundError:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/connect.v1.ConnectorError'
example:
error:
code: 404
message: account not found
connect.v1.UnauthenticatedError:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/connect.v1.ConnectorError'
example:
error:
code: 401
message: Unauthorized
connect.v1.DefaultSystemError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/connect.v1.ConnectorError'
example:
error:
code: 500
message: Oops, something went wrong
securitySchemes:
cloud-api-key:
type: http
scheme: basic
description: Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
confluent-sts-access-token:
type: oauth2
description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
flows:
clientCredentials:
tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token
scopes: {}
global-api-key:
type: http
scheme: basic
description: Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
resource-api-key:
type: http
scheme: basic
description: Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret as the password.
external-access-token:
type: oauth2
description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
flows:
clientCredentials:
tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token
scopes: {}
oauth:
type: oauth2
description: Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.
flows:
clientCredentials:
tokenUrl: /oauth2/token
scopes:
partner:alter: enables partners to alter entitlements
partner:create: enables partners to create entitlements and signup on behalf of customers
partner:delete: enables partners to delete entitlements and organizations
partner:describe: enables partners to read and list entitlements and organizations
x-tagGroups:
- name: Identity Access Management (v2)
tags:
- API Keys (iam/v2)
- Users (iam/v2)
- Service Accounts (iam/v2)
- Invitations (iam/v2)
- IP Groups (iam/v2)
- IP Filters (iam/v2)
- IP Filter Summaries (iam/v2)
- Role Bindings (iam/v2)
- Identity Providers (iam/v2)
- Jwks (iam/v2)
- Identity Pools (iam/v2)
- Group Mappings (iam/v2/sso)
- Certificate Authorities (iam/v2)
- Certificate Identity Pools (iam/v2)
- name: Org API (v2)
tags:
- Environments (org/v2)
- Organizations (org/v2)
- name: Notifications API (v1)
tags:
- Subscriptions (notifications/v1)
- Integrations (notifications/v1)
- Notification Types (notifications/v1)
- Resource Preferences (notifications/v1)
- Resource Subscriptions (notifications/v1)
- User Notifications (notifications/v1)
- name: Cluster Mgmt for Kafka (v2)
tags:
- Clusters (cmk/v2)
- name: Cluster Mgmt for ksqlDB (v2)
tags:
- Clusters (ksqldbcm/v2)
- name: Connect API (v1)
tags:
- Connectors (connect/v1)
- Lifecycle (connect/v1)
- Status (connect/v1)
- Managed Connector Plugins (connect/v1)
- Offsets (connect/v1)
- Custom Connector Plugins (connect/v1)
- Presigned Urls (connect/v1)
- Custom Connector Runtimes (connect/v1)
- name: Connect Artifact Management (v1)
tags:
- Connect Artifacts (cam/v1)
- Presigned Urls (cam/v1)
- name: Kafka API (v3)
tags:
- Cluster (v3)
- Configs (v3)
- ACL (v3)
- Consumer Group (v3)
- Partition (v3)
- Topic (v3)
- Records (v3)
- Cluster Linking (v3)
- Share Group (v3)
- Streams Group (v3)
- name: Service Quota API (v1)
tags:
- Applied Quotas (service-quota/v1)
- Scopes (service-quota/v1)
- name: Partner API (v2)
tags:
- Entitlements (partner/v2)
- Organizations (partner/v2)
- Signup (partner/v2)
- name: Cluster Mgmt for Schema Registry (v2)
tags:
- Regions (srcm/v2)
- Clusters (srcm/v2)
- name: Cluster Mgmt for Schema Registry (v3)
tags:
- Clusters (srcm/v3)
- name: Schema Registry API (v1)
tags:
- Compatibility (v1)
- Config (v1)
- Contexts (v1)
- Exporters (v1)
- Modes (v1)
- Schemas (v1)
- Subjects (v1)
- Key Encryption Keys (v1)
- Data Encryption Keys (v1)
- name: Catalog API (v1)
tags:
- Entity (v1)
- Search (v1)
- Types (v1)
- name: Stream Sharing API (v1)
tags:
- Provider Shared Resources (cdx/v1)
- Provider Shares (cdx/v1)
- Consumer Shared Resources (cdx/v1)
- Consumer Shares (cdx/v1)
- Shared Tokens (cdx/v1)
- Opt Ins (cdx/v1)
- name: Networking (v1)
tags:
- Networks (networking/v1)
- Peerings (networking/v1)
- Transit Gateway Attachments (networking/v1)
- Private Link Accesses (networking/v1)
- Network Link Services (networking/v1)
- Network Link Endpoints (networking/v1)
- Network Link Service Associations (networking/v1)
- IP Addresses (networking/v1)
- Private Link Attachments (networking/v1)
- Private Link Attachment Connections (networking/v1)
- DNS Forwarders (networking/v1)
- Access Points (networking/v1)
- DNS Records (networking/v1)
- Gateways (networking/v1)
- name: Security Token Service (v1)
tags:
- OAuth Tokens (sts/v1)
- name: Kafka Quota (v1)
tags:
- Client Quotas (kafka-quotas/v1)
- name: Bring Your Own Key (BYOK) Management (v1)
tags:
- Keys (byok/v1)
- name: Billing API (v1)
tags:
- Costs (billing/v1)
- name: Compute Pool Mgmt for Flink (v2)
tags:
- Compute Pools (fcpm/v2)
- Regions (fcpm/v2)
- Org Compute Pool Configs (fcpm/v2)
- name: SQL API (v1)
tags:
- Statements (sql/v1)
- Statement Results (sql/v1)
- Statement Exceptions (sql/v1)
- Connections (sql/v1)
- Agents (sql/v1)
- Tools (sql/v1)
- Materialized Tables (sql/v1)
- Materialized Table Versions (sql/v1)
- name: Provider Integration Management (v1)
tags:
- Integrations (pim/v1)
- name: Provider Integration Management (v2)
tags:
- Integrations (pim/v2)
- name: Artifact API (v1)
tags:
- Flink Artifacts (artifact/v1)
- Presigned Urls (artifact/v1)
- Flink Artifact Versions (artifact/v1)
- name: Custom Code Logging API (v1)
tags:
- Custom Code Loggings (ccl/v1)
- name: Tableflow (v1)
tags:
- Regions (tableflow/v1)
- Tableflow Topics (tableflow/v1)
- Catalog Integrations (tableflow/v1)
- name: Custom Connect Plugin Management (v1)
tags:
- Custom Connect Plugins (ccpm/v1)
- Presigned Urls (ccpm/v1)
- Custom Connect Plugin Versions (ccpm/v1)
- name: Unified Stream Manager (v1)
tags:
- Kafka Clusters (usm/v1)
- Connect Clusters (usm/v1)
- name: Endpoint (v1)
tags:
- Endpoints (endpoint/v1)
- name: Real Time Context Engine (v1)
tags:
- Rtce Topics (rtce/v1)
- Regions (rtce/v1)
- name: Analytics (v1alpha1)
tags:
- Statements (query/v1alpha1)