Access Points (networking/v1)5

ACL (v3)4

Agents (sql/v1)5

API Keys (iam/v2)5

Applied Quotas (service-quota/v1)2

Catalog Integrations (tableflow/v1)5

Certificate Authorities (iam/v2)5

Certificate Identity Pools (iam/v2)5

Client Quotas (kafka-quotas/v1)5

Cluster (v3)1

Cluster Linking (v3)20

Clusters (cmk/v2)5

Clusters (ksqldbcm/v2)4

Clusters (srcm/v2)5

Clusters (srcm/v3)2

Compatibility (v1)2

Compute Pools (fcpm/v2)5

Config (v1)7

Configs (v3)17

Connect Artifacts (cam/v1)4

Connect Clusters (usm/v1)4

Connections (sql/v1)5

Connectors (connect/v1)7

Consumer Group (v3)7

Consumer Shared Resources (cdx/v1)4

Consumer Shares (cdx/v1)3

Contexts (v1)1

Costs (billing/v1)1

Custom Code Loggings (ccl/v1)5

Custom Connect Plugin Versions (ccpm/v1)4

Custom Connect Plugins (ccpm/v1)5

Custom Connector Plugins (connect/v1)5

Custom Connector Runtimes (connect/v1)1

Data Encryption Keys (v1)9

DNS Forwarders (networking/v1)5

DNS Records (networking/v1)5

Endpoints (endpoint/v1)1

Entitlements (partner/v2)3

Entity (v1)10

Environments (org/v2)5

Exporters (v1)11

Flink Artifacts (artifact/v1)5

Gateways (networking/v1)5

Group Mappings (iam/v2/sso)5

Identity Pools (iam/v2)5

Identity Providers (iam/v2)5

Integrations (notifications/v1)6

Integrations (pim/v1)4

Integrations (pim/v2)6

Invitations (iam/v2)4

IP Addresses (networking/v1)1

IP Filter Summaries (iam/v2)1

IP Filters (iam/v2)5

IP Groups (iam/v2)5

Jwks (iam/v2)1

Kafka Clusters (usm/v1)4

Key Encryption Keys (v1)7

Keys (byok/v1)5

Lifecycle (connect/v1)3

Managed Connector Plugins (connect/v1)3

Materialized Table Versions (sql/v1)2

Materialized Tables (sql/v1)5

Modes (v1)5

Network Link Endpoints (networking/v1)5

Network Link Service Associations (networking/v1)2

Network Link Services (networking/v1)5

Networks (networking/v1)5

Notification Types (notifications/v1)2

OAuth Tokens (sts/v1)1

Offsets (connect/v1)3

Opt Ins (cdx/v1)2

Org Compute Pool Configs (fcpm/v2)2

Organizations (org/v2)3

Organizations (partner/v2)2

Partition (v3)2

Peerings (networking/v1)5

Presigned Urls (artifact/v1)1

Presigned Urls (cam/v1)1

Presigned Urls (ccpm/v1)1

Presigned Urls (connect/v1)1

Private Link Accesses (networking/v1)5

Private Link Attachment Connections (networking/v1)5

Private Link Attachments (networking/v1)5

Provider Shared Resources (cdx/v1)6

Provider Shares (cdx/v1)5

Records (v3)1

Regions (fcpm/v2)1

Regions (rtce/v1)1

Regions (srcm/v2)2

Regions (tableflow/v1)1

Resource Preferences (notifications/v1)5

Resource Subscriptions (notifications/v1)5

Role Bindings (iam/v2)4

Rtce Topics (rtce/v1)5

Schemas (v1)6

Scopes (service-quota/v1)2

Search (v1)2

Service Accounts (iam/v2)5

Share Group (v3)6

Shared Tokens (cdx/v1)2

Signup (partner/v2)3

Statement Exceptions (sql/v1)1

Statement Results (sql/v1)1

Statements (query/v1alpha1)2

Statements (sql/v1)6

Status (connect/v1)2

Streams Group (v3)12

Subjects (v1)10

Subscriptions (notifications/v1)5

Tableflow Topics (tableflow/v1)5

Tools (sql/v1)4

Topic (v3)5

Transit Gateway Attachments (networking/v1)5

Types (v1)10

User Notifications (notifications/v1)5

Users (iam/v2)5

Connect Clusters (usm/v1)

Read a Connect Cluster

Make a request to read a connect cluster.

get/usm/v1/connect-clusters/{id}

Path parameters

idstring required

The unique identifier for the connect cluster.

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Connect Cluster.

api_version'usm/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'ConnectCluster' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

confluent_platform_connect_cluster_idstring required

The unique identifier of the Connect cluster within the Confluent Platform environment.

kafka_cluster_idstring required

The unique identifier of the metadata Kafka cluster for the Connect Cluster.

usm_kafka_cluster_idstring

The unique identifier of the metadata Kafka cluster for the Connect Cluster.

cloudstring

The cloud service provider where the metadata for the Connect Cluster should be stored. This field is optional. If provided, 'region' must also be provided. If neither 'cloud' nor 'region' are provided, the cloud provider of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.

regionstring

The home region of the Confluent Platform Connect cluster where the metadata should be stored. This field is optional. If provided, 'cloud' must also be provided. If neither 'cloud' nor 'region' are provided, the home region of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.

Example response

{
  "id": "dlz-f3a90de",
  "confluent_platform_connect_cluster_id": "connect-group-xyz123",
  "kafka_cluster_id": "4k0R9d1GTS5tI9f4Y2xZ0Q",
  "usm_kafka_cluster_id": "usmkc-00000",
  "cloud": "AWS",
  "region": "us-east-1",
  "environment": {
    "id": "env-00000",
    "related": "https://api.confluent.cloud/v2/environments/env-00000",
    "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.