Confluent | the Data Streaming Platform

Confluent | the Data Streaming Platform Cluster Linking (v3) API

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

GitHub OpenAPI

Operations 20

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 /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs List a cluster link's configs · List all configs of the cluster link #
Ask an LLM
“What configuration settings does my cluster link currently have?”
“Can I see every config value on one cluster link at once?”
Tell an agent
List all configs of cluster link {link_name} on {cluster_id}.
Dump the full config set for link {link_name} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Get one cluster link config value · Describe the config under the cluster link #
Ask an LLM
“What is the current value of a single setting on my cluster link?”
“Is one particular cluster link config still at its default?”
Tell an agent
Show config {config_name} on cluster link {link_name} in {cluster_id}.
Get the value of {config_name} for link {link_name}.
PUT /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Change one cluster link config · Alter the config under the cluster link #
Ask an LLM
“How do I change a single setting on an existing cluster link?”
“Can I update just one config on a cluster link without touching the others?”
Tell an agent
Set config {config_name} on cluster link {link_name} to {value}.
Alter {config_name} to {value} on link {link_name} in cluster {cluster_id}.
DELETE /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Reset a cluster link config to default · Reset the given config to default value #
Ask an LLM
“How do I put a cluster link setting back to its default value?”
“Can I undo an override I made to one cluster link config?”
Tell an agent destructive · confirm first
Reset config {config_name} on cluster link {link_name} to its default.
Remove the override for {config_name} on link {link_name} in {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter Change several cluster link configs at once · Batch Alter Cluster Link Configs #
Ask an LLM
“Can I alter multiple cluster link settings in a single request?”
“Is there a way to dry-run a batch of cluster link config changes first?”
Tell an agent
Batch alter these configs {data} on cluster link {link_name}.
Validate the batch config changes {data} for link {link_name} in {cluster_id} without applying them.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors Create a mirror topic over a cluster link · Create a mirror topic #
Ask an LLM
“How do I start mirroring a source topic into my destination cluster?”
“Can I give the mirror topic a different name than the source topic?”
Tell an agent
Mirror source topic {source_topic_name} over cluster link {link_name}.
Create mirror topic {mirror_topic_name} from {source_topic_name} on link {link_name} in {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/links/-/mirrors List all mirror topics in a cluster · List mirror topics #
Ask an LLM
“What mirror topics exist in my cluster across every cluster link?”
“Can I find all failed mirror topics in a cluster regardless of link?”
Tell an agent
List every mirror topic across all links in cluster {cluster_id}.
Show all mirror topics in {cluster_id} whose status is {mirror_status}, across every link.
GET /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name} Describe a mirror topic · Describe the mirror topic #
Ask an LLM
“What is the mirroring status and lag of one specific mirror topic?”
“Can I see the state transition errors for a mirror topic?”
Tell an agent
Describe mirror topic {mirror_topic_name} on link {link_name} in {cluster_id}.
Show mirror topic {mirror_topic_name} including its state transition errors.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote Promote mirror topics to regular topics · Promote the mirror topics #
Ask an LLM
“How do I promote mirror topics so they become writable in the destination cluster?”
“Can I promote every mirror topic matching a name pattern at once?”
Tell an agent destructive · confirm first
Promote mirror topics {mirror_topic_names} on link {link_name}.
Promote all mirror topics matching {mirror_topic_name_pattern} on link {link_name} in {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover Fail over mirror topics · Failover the mirror topics #
Ask an LLM
“How do I fail over mirror topics when the source cluster is down?”
“Can I test a mirror topic failover with validate only before doing it?”
Tell an agent destructive · confirm first
Fail over mirror topics {mirror_topic_names} on link {link_name}.
Fail over every mirror topic matching {mirror_topic_name_pattern} on link {link_name} in {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause Pause mirror topics · Pause the mirror topics #
Ask an LLM
“Can I temporarily stop mirroring on some mirror topics?”
“How would I pause replication for mirror topics that match a pattern?”
Tell an agent
Pause mirror topics {mirror_topic_names} on link {link_name}.
Pause mirroring for topics matching {mirror_topic_name_pattern} on link {link_name} in {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume Resume paused mirror topics · Resume the mirror topics #
Ask an LLM
“How do I restart mirroring on mirror topics I paused earlier?”
“Can I resume paused mirror topics by name pattern?”
Tell an agent
Resume paused mirror topics {mirror_topic_names} on link {link_name}.
Resume mirroring for paused topics matching {mirror_topic_name_pattern} on link {link_name} in {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror Reverse mirror direction and start remote mirror · Reverse the local mirror topic and start the remote mirror topic #
Ask an LLM
“How do I reverse a mirror so the local topic becomes the source and the remote one starts mirroring?”
“Can I flip mirroring direction back after a failover and keep the remote side running?”
Tell an agent
Reverse local mirror topics {mirror_topic_names} on link {link_name} and start the remote mirrors.
Reverse and start remote mirroring for topics matching {mirror_topic_name_pattern} on link {link_name} in {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror Reverse mirror direction and pause remote mirror · Reverse the local mirror topic and Pause the remote mirror topic #
Ask an LLM
“Can I reverse a mirror topic's direction but leave the remote mirror paused?”
“What reverses local mirror topics while keeping the remote side paused?”
Tell an agent
Reverse local mirror topics {mirror_topic_names} on link {link_name} and pause the remote mirrors.
Reverse topics matching {mirror_topic_name_pattern} on link {link_name} in {cluster_id}, leaving the remote side paused.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore Truncate local topics and restore mirroring · Truncates the local topic to the remote stopped mirror log end offsets and… #
Ask an LLM
“How do I truncate a local topic back to the remote mirror's end offsets and resume mirroring from it?”
“Can I see partition-level truncation data when restoring a mirror topic?”
Tell an agent destructive · confirm first
Truncate and restore mirroring for topics {mirror_topic_names} on link {link_name}.
Truncate topics matching {mirror_topic_name_pattern} to the remote end offsets on link {link_name} in {cluster_id} and restore mirroring.

Documentation

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

Specifications

⚙
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

Other Resources

🔗
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

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-the-data-streaming-platform:confluent-the-data-streaming-platform-cluster-linking-v3-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-the-data-streaming-platform-cluster-linking-v3-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Cloud Cluster Linking (v3) 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:


# --- truncated at 32 KB (66 KB total) ---
# Full source: 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