COconfluent
Connectors (usm/v1)

Create connector

Changed on

Async, reconciled: 201 means the desired state passed best-effort synchronous control-plane validation and was accepted, not that the connector is confirmed running. Deeper validation (the connector's own validate(), which needs the on-prem worker) happens after the 2xx and surfaces on GET .../status.

post/usm/v1/connect-clusters/{connect_cluster_id}/connectors

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/usm/v1/connect-clusters/{connect_cluster_id}/connectors
  • Auth
    • HTTP basic
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Request body

namestring required

The connector's unique name within its environment. Immutable once created.

configUsmConnectV1ConfigMap required

Low-level connector config, native-compatible (all values strings, dotted keys like connector.class — not snake_case, to match native Kafka Connect config verbatim). Secret fields must be config-provider references (${provider:path:key}). Secrets set as config-provider references are returned as the reference on read; all other secrets are returned masked as ****.

Example request

{
  "name": "s3-sink-01",
  "config": {
    "connector.class": "io.confluent.connect.s3.S3SinkConnector",
    "tasks.max": "2",
    "topics": "orders",
    "aws.secret.access.key": "${securepass:aws:secret}"
  }
}

Response

Created (accepted; not yet necessarily running)

idstring required

The connector's unique Cloud-assigned ID (Cloud-only extension; not part of native Kafka Connect's ConnectorInfo).

namestring required

The connector's unique name within its environment.

typestring required

Whether the connector is a source or sink.

configUsmConnectV1ConfigMap required

Low-level connector config, native-compatible (all values strings, dotted keys like connector.class — not snake_case, to match native Kafka Connect config verbatim). Secret fields must be config-provider references (${provider:path:key}). Secrets set as config-provider references are returned as the reference on read; all other secrets are returned masked as ****.

data_cluster_scopestring

Whether the connector's data Kafka cluster (distinct from the Connect cluster's metadata Kafka cluster) is a Confluent Cloud cluster. UNKNOWN is common and must be handled as a first-class value.

Example response

{
  "id": "usmco-a1b2c3",
  "config": {
    "connector.class": "io.confluent.connect.s3.S3SinkConnector",
    "tasks.max": "2",
    "topics": "orders",
    "aws.secret.access.key": "${securepass:aws:secret}"
  }
}

Changes