Sign in
Cluster Linking (v3)

Create a cluster link

Generally Available

Cluster link creation requires source cluster security configurations in the configs JSON section of the data request payload.

post/kafka/v3/clusters/{cluster_id}/links

Query parameters

link_namestring required

The link name

validate_onlyboolean

To validate the action can be performed successfully or not. Default: false

validate_linkboolean

To synchronously validate that the source cluster ID is expected and the dest cluster has the permission to read topics in the source cluster. Default: true

Request body

source_cluster_idstring
destination_cluster_idstring
remote_cluster_idstring

The expected remote cluster ID.

cluster_link_idstring

The expected cluster link ID. Can be provided when creating the second side of a bidirectional link for validating the link ID is as expected. If it's not provided, it's inferred from the remote cluster.

Example request

{
  "configs": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}

Response

Operation succeeded, no content in the response

Changes