# Confluent | the Data Streaming Platform Cluster Linking (v3) API **Canonical:** https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-cluster-linking-v3-api/ **Provider:** Confluent | the Data Streaming Platform — https://apis.io/providers/confluent-the-data-streaming-platform/ **Base URL:** https://api.confluent.cloud **Documentation:** https://docs.confluent.io/cloud/current/api.html Confluent | the Data Streaming Platform Cluster Linking (v3) API is one of 121 APIs that [Confluent | the Data Streaming Platform](https://apis.io/providers/confluent-the-data-streaming-platform/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Cluster Linking (v3). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference. [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) ## Operations (20) | Method | Path | Summary | |---|---|---| | GET | `/kafka/v3/clusters/{cluster_id}/links` | List all cluster links in the dest cluster | | POST | `/kafka/v3/clusters/{cluster_id}/links` | Create a cluster link | | GET | `/kafka/v3/clusters/{cluster_id}/links/{link_name}` | Describe the cluster link | | DELETE | `/kafka/v3/clusters/{cluster_id}/links/{link_name}` | Delete the cluster link | | GET | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs` | List all configs of the cluster link | | GET | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}` | Describe the config under the cluster link | | PUT | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}` | Alter the config under the cluster link | | DELETE | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}` | Reset the given config to default value | | PUT | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter` | Batch Alter Cluster Link Configs | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors` | Create a mirror topic | | GET | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors` | List mirror topics | | GET | `/kafka/v3/clusters/{cluster_id}/links/-/mirrors` | List mirror topics | | GET | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}` | Describe the mirror topic | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote` | Promote the mirror topics | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover` | Failover the mirror topics | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause` | Pause the mirror topics | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume` | Resume the mirror topics | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror` | Reverse the local mirror topic and start the remote mirror topic | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror` | Reverse the local mirror topic and Pause the remote mirror topic | | POST | `/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore` | Truncates the local topic to the remote stopped mirror log end offsets and… | ## Machine-readable artifacts (5) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-cluster-linking-v3-api-openapi.yml - **Documentation** — https://docs.confluent.io/cloud/current/api.html - **APIReference** — https://docs.confluent.io/cloud/current/api.html - **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 ## Other Confluent | the Data Streaming Platform APIs (12) - [Confluent Kafka REST API](https://apis.io/apis/confluent-the-data-streaming-platform/kafka-rest-api/) - [Confluent Schema Registry REST API](https://apis.io/apis/confluent-the-data-streaming-platform/schema-registry-api/) - [Kafka Connect REST API](https://apis.io/apis/confluent-the-data-streaming-platform/connect-rest-api/) - [ksqlDB REST API](https://apis.io/apis/confluent-the-data-streaming-platform/ksqldb-rest-api/) - [Confluent Cloud for Apache Flink REST API](https://apis.io/apis/confluent-the-data-streaming-platform/flink-rest-api/) - [Confluent | the Data Streaming Platform Access Points (networking/v1) API](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-access-points-networking-v1-api/) - [Confluent | the Data Streaming Platform ACL (v3) API](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-acl-v3-api/) - [Confluent | the Data Streaming Platform Agents (sql/v1) API](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-agents-sql-v1-api/) - [Confluent | the Data Streaming Platform API Keys (iam/v2) API](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-api-keys-iam-v2-api/) - [Confluent | the Data Streaming Platform Applied Quotas (service-quota/v1) API](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-applied-quotas-service-quota-v1-api/) - [Confluent | the Data Streaming Platform Catalog Integrations (tableflow/v1) API](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-catalog-integrations-tableflow-v1-api/) - [Confluent | the Data Streaming Platform Certificate Authorities (iam/v2) API](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-certificate-authorities-iam-v2-api/) ## Tags Cluster Linking (v3) --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/confluent-the-data-streaming-platform/confluent-the-data-streaming-platform-cluster-linking-v3-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/confluent-the-data-streaming-platform/.