Confluent

Confluent 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 all configs of a cluster link · List all configs of the cluster link #
Ask an LLM
“What configuration settings are applied to my cluster link?”
“Can I dump every config value for one cluster link?”
Tell an agent
List all configs of cluster link {link_name} on cluster {cluster_id}.
Show every setting on link {link_name} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Get one config value on a cluster link · Describe the config under the cluster link #
Ask an LLM
“What value is a single named config set to on my cluster link?”
“Is a specific cluster link setting still at its default?”
Tell an agent
Get config {config_name} on cluster link {link_name} in cluster {cluster_id}.
Tell me the current value of {config_name} for link {link_name} on cluster {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Change one config on a cluster link · Alter the config under the cluster link #
Ask an LLM
“How do I change a single setting on an existing cluster link?”
“Can I alter one cluster link config without touching the others?”
Tell an agent
Set config {config_name} to {value} on cluster link {link_name} in cluster {cluster_id}.
Update the {config_name} setting of link {link_name} on cluster {cluster_id} to {value}.
DELETE /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Reset a cluster link config to its default · Reset the given config to default value #
Ask an LLM
“How do I revert a cluster link setting back to its default value?”
“Can I undo an override I made on a cluster link config?”
Tell an agent destructive · confirm first
Reset config {config_name} on cluster link {link_name} in cluster {cluster_id} to default.
Remove my override of {config_name} on link {link_name} in cluster {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter Alter several cluster link configs at once · Batch Alter Cluster Link Configs #
Ask an LLM
“Can I change multiple cluster link settings in a single request?”
“Is there a way to validate a batch of cluster link config changes before applying them?”
Tell an agent
Apply these config changes {data} to cluster link {link_name} on cluster {cluster_id} in one batch.
Validate only, without applying, the batch config changes {data} for link {link_name} on cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors Create a mirror topic on 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 link {link_name} into cluster {cluster_id}.
Create mirror topic {mirror_topic_name} from {source_topic_name} on link {link_name} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/links/-/mirrors List all mirror topics across a cluster's links · List mirror topics #
Ask an LLM
“Which mirror topics exist in my cluster across every cluster link?”
“Can I find all stopped mirror topics in a cluster regardless of link?”
Tell an agent
List every mirror topic in cluster {cluster_id} across all links.
Show all mirror topics in cluster {cluster_id} whose status is {mirror_status}, on any link.
GET /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name} Describe a single mirror topic · Describe the mirror topic #
Ask an LLM
“What is the mirroring status and lag of one particular mirror topic?”
“Can I see state transition errors for a mirror topic?”
Tell an agent
Describe mirror topic {mirror_topic_name} on link {link_name} in cluster {cluster_id}.
Show state transition errors for mirror topic {mirror_topic_name} on link {link_name}, cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote Promote mirror topics to writable topics · Promote the mirror topics #
Ask an LLM
“How do I promote mirror topics so producers can write to them on the destination?”
“Can I promote mirror topics by name pattern instead of listing each one?”
Tell an agent destructive · confirm first
Promote mirror topics {mirror_topic_names} on link {link_name} in cluster {cluster_id}.
Promote every mirror topic matching {mirror_topic_name_pattern} on link {link_name}, cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover Fail over mirror topics to the destination · Failover the mirror topics #
Ask an LLM
“What do I call to fail over mirror topics when the source cluster is down?”
“Can I test a mirror topic failover with validate-only first?”
Tell an agent destructive · confirm first
Fail over mirror topics {mirror_topic_names} on link {link_name} in cluster {cluster_id}.
Run a failover for mirror topics matching {mirror_topic_name_pattern} on link {link_name}, cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause Pause mirroring for mirror topics · Pause the mirror topics #
Ask an LLM
“How do I temporarily stop replication on some mirror topics?”
“Can I pause a group of mirror topics that match a pattern?”
Tell an agent
Pause mirror topics {mirror_topic_names} on link {link_name} in cluster {cluster_id}.
Pause mirroring for topics matching {mirror_topic_name_pattern} on link {link_name}, cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume Resume mirroring for paused mirror topics · Resume the mirror topics #
Ask an LLM
“How do I restart replication on mirror topics I paused earlier?”
“Can I resume paused mirror topics by name pattern?”
Tell an agent
Resume mirror topics {mirror_topic_names} on link {link_name} in cluster {cluster_id}.
Resume the paused mirror topics matching {mirror_topic_name_pattern} on link {link_name}, cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror Reverse mirror direction and start the remote mirror · Reverse the local mirror topic and start the remote mirror topic #
Ask an LLM
“Can I reverse replication so the remote topic mirrors from my local one and keeps running?”
“What do I use to fail back by reversing mirror topics and starting the remote side?”
Tell an agent
Reverse local mirror topics {mirror_topic_names} on link {link_name} in cluster {cluster_id} and start the remote mirror.
Reverse-and-start mirroring for topics matching {mirror_topic_name_pattern} on link {link_name}, cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror Reverse mirror direction and pause the remote mirror · Reverse the local mirror topic and Pause the remote mirror topic #
Ask an LLM
“Can I reverse mirror topics but leave the remote mirror paused?”
“Which call reverses replication direction while keeping the remote side paused?”
Tell an agent
Reverse local mirror topics {mirror_topic_names} on link {link_name} in cluster {cluster_id} and pause the remote mirror.
Reverse-and-pause mirroring for topics matching {mirror_topic_name_pattern} on link {link_name}, cluster {cluster_id}.
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 my local topic to the remote stopped mirror's end offsets and mirror again?”
“Can I see partition-level truncation details when restoring a mirror?”
Tell an agent destructive · confirm first
Truncate and restore mirroring for topics {mirror_topic_names} on link {link_name} in cluster {cluster_id}.
Truncate topics matching {mirror_topic_name_pattern} to the remote end offsets and resume mirroring on link {link_name}, cluster {cluster_id}.

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/openapi/confluent-cluster-linking-v3-api-openapi.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:confluent-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-cluster-linking-v3-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent 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: 'Operations tagged Cluster Linking (v3) across 2 of this provider''s published API definitions: confluent-cloud-openapi.yaml, confluent-cloud-full.yaml. Each path carries the servers of the definition it was published in.'
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/refs/heads/main/openapi/confluent-cluster-linking-v3-api-openapi.yml