How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Confluent

Confluent Cluster Linking (v3) API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Confluent Cluster Linking (v3) API is one of 127 APIs that Confluent publishes on the 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 and an API reference.

This API exposes 20 operations across 15 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.confluent.cloud.

20 operations 15 paths 32 schemas 2 DELETE7 GET9 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.confluent.cloud
Authentication
HTTP Basic, OAuth 2.0, HTTP Basic, HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 6

Confluent Cluster Linking (v3) API declares 6 security schemes for authenticating requests. It accepts HTTP basic authentication (cloud-api-key). It supports OAuth 2.0 (confluent-sts-access-token) using the clientCredentials flow. It accepts HTTP basic authentication (global-api-key). It accepts HTTP basic authentication (resource-api-key). It supports OAuth 2.0 (external-access-token) using the clientCredentials flow. It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 4 scopes.

  • cloud-api-key — Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
  • confluent-sts-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • global-api-key — Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
  • resource-api-key — Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret…
  • external-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • oauth — Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 2 DELETE, 7 GET, 9 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Cluster Linking (v3) 20

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

GET
/kafka/v3/clusters/{cluster_id}/links
List all cluster links in the dest cluster
listKafkaLinks 1 param → 2004004014295XX
POST
/kafka/v3/clusters/{cluster_id}/links
Create a cluster link
createKafkaLink 4 params body → 2044004014295XX
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}
Describe the cluster link
getKafkaLink 3 params → 2004004014295XX
DELETE
/kafka/v3/clusters/{cluster_id}/links/{link_name}
Delete the cluster link
deleteKafkaLink 4 params → 2004004014295XX
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs
List all configs of the cluster link
listKafkaLinkConfigs 2 params → 2004004014295XX
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}
Describe the config under the cluster link
getKafkaLinkConfigs 3 params → 2004004014295XX
PUT
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}
Alter the config under the cluster link
updateKafkaLinkConfig 3 params body → 2044004014295XX
DELETE
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}
Reset the given config to default value
deleteKafkaLinkConfig 3 params → 2044004014295XX
PUT
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter
Batch Alter Cluster Link Configs
updateKafkaLinkConfigBatch 3 params body → 2044004014295XX
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors
Create a mirror topic
createKafkaMirrorTopic 2 params body → 2044004014295XX
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors
List mirror topics
listKafkaMirrorTopicsUnderLink 3 params → 2004004014295XX
GET
/kafka/v3/clusters/{cluster_id}/links/-/mirrors
List mirror topics
listKafkaMirrorTopics 2 params → 2004004014295XX
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}
Describe the mirror topic
readKafkaMirrorTopic 4 params → 2004004014295XX
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote
Promote the mirror topics
updateKafkaMirrorTopicsPromote 3 params body → 2004004014295XX
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover
Failover the mirror topics
updateKafkaMirrorTopicsFailover 3 params body → 2004004014295XX
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause
Pause the mirror topics
updateKafkaMirrorTopicsPause 3 params body → 2004004014295XX
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume
Resume the mirror topics
updateKafkaMirrorTopicsResume 3 params body → 2004004014295XX
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
updateKafkaMirrorTopicsReverseAndStartMirror 3 params body → 2004004014295XX
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
updateKafkaMirrorTopicsReverseAndPauseMirror 3 params body → 2004004014295XX
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 restores mirroring to the local topic to mirror from the remote topic
updateKafkaMirrorTopicsTruncateAndRestoreMirror 4 params body → 2004004014295XX

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Error (8 properties), CreateLinkRequestData (5 properties), CreateMirrorTopicRequestData (4 properties), PartitionLevelTruncationData (3 properties). Each schema is shown below with its type and property counts.

MirrorLags
array
LinkError
string
ListLinksResponseDataList
MirrorLag
object
3 properties 3 required
ConfigData
object
2 properties 2 required
LinkTaskError
object
2 properties 2 required
AlterConfigBatchRequestData
object
2 properties 1 required
ResourceCollection
object
2 properties 2 required
AlterMirrorsRequestData
object
2 properties
ResourceCollectionMetadata
object
2 properties 1 required
AlterMirrorStatusResponseDataList
ListMirrorTopicsResponseData
PartitionLevelTruncationData
object
3 properties 3 required
ListLinkConfigsResponseDataList
ResourceMetadata
object
2 properties 1 required
LinkTask
object
3 properties 3 required
UpdateLinkConfigRequestData
object
1 property 1 required
ListLinkConfigsResponseData
PartitionLevelTruncationDataList
array
LinkTaskState
string
MirrorTopicError
string
CreateLinkRequestData
object
5 properties
MirrorTopicStatus
string
ListLinksResponseData
Error
object
Describes a particular error encountered while performing an operation.
8 properties
LinkCategory
object
2 properties 2 required
CreateMirrorTopicRequestData
object
4 properties 1 required
ListMirrorTopicsResponseDataList
LinkState
string
Resource
object
2 properties 2 required
StateCategory
string
AlterMirrorStatusResponseData

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-cluster-linking-v3-api-openapi.yml Raw ↑

Other APIs Confluent publishes across the network.

Confluent
AE Profile APIs.io
Confluent Managed MCP Servers
AE Profile APIs.io
Confluent ACLs API
AE Profile APIs.io
Confluent API Keys API
AE Profile APIs.io
Confluent Clusters API
AE Profile APIs.io
Confluent Consumer Groups API
AE Profile APIs.io
Confluent Environments API
AE Profile APIs.io
Confluent Partitions API
AE Profile APIs.io
Confluent Service Accounts API
AE Profile APIs.io
Confluent Topics API
AE Profile APIs.io
Confluent Access Points (networking/v1) API
AE Profile APIs.io
Confluent ACL (v3) API
AE Profile APIs.io
#Cluster Linking (v3)
← Back to C APIs
API Details
ID
confluent:confluent-cluster-linking-v3-api
Base URL
https://api.confluent.cloud
Docs
https://www.confluent.io/
Provider
Confluent
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=confluent-cluster-linking-v3-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/confluent-cluster-linking-v3-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Confluent Cluster Linking (v3) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.