Kafka Connect Cluster V2

Operations related to Kafka Connect cluster

Update the custom connectors of a Kafka Connect cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the Kafka Connect Cluster.

Responses
202

Successfully processed the custom connector update request.

put/cluster-management/v2/operations/applications/kafka-connect/clusters/v2/{clusterId}/sync-custom-kafka-connectors/v2
Request samples

Create a Kafka connect cluster.

SecurityBasic Authentication
Request
Request Body schema: application/json
required
Array of objects (KafkaConnectDataCentreV2) = 1 items

List of data centre settings.

currentClusterOperationStatus
string (CurrentClusterOperationStatusV2)

Indicates if the cluster is currently performing any restructuring operation such as being created or resized

Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"
privateNetworkCluster
required
boolean

Creates the cluster with private network only, see Private Network Clusters.

kafkaConnectVersion
required
string[0-9]+\.[0-9]+\.[0-9]+

Version of Kafka connect to run on the cluster. Available versions:

  • 3.1.2
  • 3.0.2
  • 2.8.2
  • 2.7.1

required
Array of objects (KafkaConnectTargetClusterDetailsV2) <= 1 items

Details to connect to a target Kafka Cluster cluster.

name
required
string [ 3 .. 32 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*

Name of the cluster.

Array of objects (KafkaConnectCustomConnectorsV2) <= 1 items

Defines the location for custom connector storage and access info.

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
slaTier
required
string (SlaTierV2)

SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See SLA Tier for more information.

Enum: "PRODUCTION" "NON_PRODUCTION"
Responses
202

Kafka connect cluster creation request accepted

post/cluster-management/v2/resources/applications/kafka-connect/clusters/v2/
Request samples
application/json
{
  • "dataCentres": [
    ],
  • "kafkaConnectVersion": "[x.y.z]",
  • "name": "MyKafkaConnectCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "targetCluster": [
    ]
}
Response samples
application/json
{
  • "dataCentres": [
    ],
  • "kafkaConnectVersion": "[x.y.z]",
  • "name": "MyKafkaConnectCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "targetCluster": [
    ]
}

Get Kafka connect cluster details

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the active cluster

Responses
200

Get Kafka connect cluster information

404

Kafka connect cluster not found

get/cluster-management/v2/resources/applications/kafka-connect/clusters/v2/{clusterId}
Request samples
Response samples
application/json
{
  • "dataCentres": [
    ],
  • "kafkaConnectVersion": "[x.y.z]",
  • "name": "MyKafkaConnectCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "targetCluster": [
    ]
}

Update a Kafka connect cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the active cluster

Request Body schema: application/json
required
Array of objects (KafkaConnectDataCentreV2) = 1 items

List of datacentre settings.

Responses
202

Kafka Connect cluster update request accepted.

404

Kafka connect cluster not found

put/cluster-management/v2/resources/applications/kafka-connect/clusters/v2/{clusterId}
Request samples
application/json
{
  • "dataCentres": [
    ]
}
Response samples
application/json
{
  • "dataCentres": [
    ],
  • "kafkaConnectVersion": "[x.y.z]",
  • "name": "MyKafkaConnectCluster",
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "targetCluster": [
    ]
}

Delete Kafka connect Cluster

Delete an active cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the active cluster

Responses
204

Cluster delete requested.

delete/cluster-management/v2/resources/applications/kafka-connect/clusters/v2/{clusterId}
Request samples