Instaclustr Logo
Powered by Redocly

Kafka Mirroring API

Operations related to managing mirroring setups between Kafka and Kafka Connect clusters.

List all mirroring configurations

Lists all current mirroring configurations for the given cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 0c7067d6-c70a-11ea-87d0-0242ac130003
Responses
200

Successfully retrieved all mirroring configs

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/{clusterId}/kafka-connect/mirrors
Request samples 
Response samples 
application/json
{
  • "mirrors": [
    ]
}
Create a new mirroring configuration
Creates a new mirroring configuration that will be set up asynchronously. Returns an id that represents the configuration


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
Request Body schema: application/json
required
Create new mirror request


One of:
sourceType
string
Indicates that your source cluster is an instaclustr managed cluster


 Value: "instaclustr"  
useRenaming
boolean
Whether to rename topics as they are mirrored, by prefixing the source alias to the topic name


 
kafkaSource
string
Id of your source instaclustr Kafka cluster


 
usePrivateIps
boolean
Whether or not to connect to  your source cluster's private IP addresses


 
sourceAlias
string
Alias to use for your source Kafka cluster. This will be used to rename topics if that option is turned on


 
topicsRegex
string
Regex to select which topics to mirror


 
maxTasks
integer <int32> 
Maximum number of tasks for Kafka Connect to use


 
Responses 
200
Successfully created new mirroring config


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


post/provisioning/v1/{clusterId}/kafka-connect/mirrors
Request samples 
application/json
{
  • "sourceType": "custom",
  • "useRenaming": true,
  • "kafkaSource": "ff4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "usePrivateIps": false,
  • "sourceAlias": "production-west",
  • "topicsRegex": "west-.*",
  • "maxTasks": 3
}
Response samples 
application/json
{
  • "mirrorId": "ff4fccf3-2ac0-494b-9f40-e95288dd752d"
}
Get mirroring configuration details
Get details about a specific mirroring configuration


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
mirrorId
required
string
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
Responses 
200
Successfully retrieved mirroring config detail


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


get/provisioning/v1/{clusterId}/kafka-connect/mirrors/{mirrorId}
Request samples 
Response samples 
application/json
{
  • "id": "ff4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "status": "IN_SYNC",
  • "connectorName": "source.target.stFR45Jhdg5r",
  • "targetLatency": 30000,
  • "topicsRegex": ".*",
  • "mirrorStatus": "RUNNING",
  • "checkpointStatus": "RUNNING",
  • "topicStatuses": [
    ]
}
Delete a mirroring configuration
Deletes a specific mirroring configuration, shutting down all its connectors and tasks


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
mirrorId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
Responses 
204
Successfully deleted mirroring config


400
Bad Request


401
Not Authorized


403
Forbidden. User doesn't have permission to perform this operation


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


delete/provisioning/v1/{clusterId}/kafka-connect/mirrors/{mirrorId}
Request samples 
Response samples 
application/json
{
  • "status": 0,
  • "message": "string",
  • "errorDetails": { },
  • "code": 0,
  • "link": "string"
}
Update a mirror's target latency
Updates a mirror's target latency. The target latency is the measure above which this mirror will be considered out of sync.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
mirrorId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
Request Body schema: application/json
newTargetLatency
required
integer <int32>   >= 1000 
The new target latency in milliseconds to set.


 
Responses 
204
Successfully updated target latency


400
Bad Request


401
Not Authorized


403
Forbidden. User doesn't have permission to perform this operation


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


put/provisioning/v1/{clusterId}/kafka-connect/mirrors/{mirrorId}/targetLatency
Request samples 
application/json
{
  • "newTargetLatency": 1000
}
Response samples 
application/json
{
  • "status": 0,
  • "message": "string",
  • "errorDetails": { },
  • "code": 0,
  • "link": "string"
}
➔ Next to Kafka Topic