Kafka Connect Mirror V2

Operations related to Kafka Connect Mirror.

List all Kafka connect mirrors.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the Kafka Connect cluster.

Responses
200

Successfully retrieved Kafka mirrors.

get/cluster-management/v2/data-sources/kafka_connect_cluster/{clusterId}/mirrors/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

Create a Kafka Connect mirror

SecurityBasic Authentication
Request
Request Body schema: application/json
targetLatency
required
integer

The latency in milliseconds above which this mirror will be considered out of sync. It can not be less than 1000ms. The suggested initial latency is 30000ms for connectors to be created.

kafkaConnectClusterId
required
string

ID of the kafka connect cluster

required
Array of objects (KafkaConnectMirrorSourceClusterDetailsV2) = 1 items

Details to connect to the source kafka cluster

maxTasks
required
integer

Maximum number of tasks for Kafka Connect to use. Should be greater than 0.

renameMirroredTopics
required
boolean

Whether to rename topics as they are mirrored, by prefixing the sourceCluster.alias to the topic name.

topicsRegex
required
string

Regex to select which topics to mirror.

Responses
202

Kafka Connect mirror creation requested.

post/cluster-management/v2/resources/applications/kafka_connect/mirrors/v2
Request samples
application/json
{
  • "kafkaConnectClusterId": "[UUID of the kafka connect cluster]",
  • "maxTasks": 3,
  • "renameMirroredTopics": true,
  • "sourceCluster": [
    ],
  • "targetLatency": 5000,
  • "topicsRegex": ".*"
}
Response samples
application/json
{
  • "kafkaConnectClusterId": "[UUID of the kafka connect cluster]",
  • "maxTasks": 3,
  • "renameMirroredTopics": true,
  • "sourceCluster": [
    ],
  • "targetLatency": 5000,
  • "topicsRegex": ".*"
}

Get the details of a kafka connect mirror

SecurityBasic Authentication
Request
path Parameters
mirrorId
required
string <uuid>

ID of the Kafka Connect mirror.

Responses
200

Successfully retrieved kafka connect mirror details.

get/cluster-management/v2/resources/applications/kafka_connect/mirrors/v2/{mirrorId}
Request samples
Response samples
application/json
{
  • "kafkaConnectClusterId": "[UUID of the kafka connect cluster]",
  • "maxTasks": 3,
  • "renameMirroredTopics": true,
  • "sourceCluster": [
    ],
  • "targetLatency": 5000,
  • "topicsRegex": ".*"
}

Update a Kafka Connect mirror.

SecurityBasic Authentication
Request
path Parameters
mirrorId
required
string <uuid>

ID of the Kafka Connect mirror.

Request Body schema: application/json
targetLatency
required
integer

The latency in milliseconds above which this mirror will be considered out of sync.

Responses
200

Successfully updated the Kafka Connect mirror details.

put/cluster-management/v2/resources/applications/kafka_connect/mirrors/v2/{mirrorId}
Request samples
application/json
{
  • "targetLatency": 0
}
Response samples
application/json
{
  • "kafkaConnectClusterId": "[UUID of the kafka connect cluster]",
  • "maxTasks": 3,
  • "renameMirroredTopics": true,
  • "sourceCluster": [
    ],
  • "targetLatency": 5000,
  • "topicsRegex": ".*"
}

Delete a Kafka Connect Mirror

SecurityBasic Authentication
Request
path Parameters
mirrorId
required
string <uuid>

ID of the Kafka Connect mirror.

Responses
204

Successfully processed the delete request of a Kafka Connect mirror.

delete/cluster-management/v2/resources/applications/kafka_connect/mirrors/v2/{mirrorId}
Request samples