Kafka Cluster V2

Create a Kafka cluster.

SecurityBasic Authentication
Request
Request Body schema: application/json
clientBrokerAuthWithMtls
boolean

Enables Client ⇄ Broker Authentication with mTLS.

pciComplianceMode
required
boolean

Creates a PCI compliant cluster, see PCI Compliance.

Array of objects (KafkaSchemaRegistryDetailsV2) <= 1 items

Adds the specified version of Kafka Schema Registry to this Kafka cluster.

defaultReplicationFactor
required
integer

Default Replication factor to use for new topic. Also represents the number of racks to use when allocating nodes.

defaultNumberOfPartitions
required
integer

Default number of partitions to use when created new topics.

clientAuthBrokerWithoutEncryption
boolean

Enables Client ⇄ Broker Authentication without Encryption.

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
Array of objects (KafkaKarapaceRestProxyDetailsV2) <= 1 items

Adds the specified version of Kafka Karapace REST Proxy to this Kafka cluster.

allowDeleteTopics
required
boolean

Allows topics to be deleted via the kafka-topics tool

autoCreateTopics
required
boolean

Allows topics to be auto created by brokers when messages are published to a non-existent topic

Array of objects (KafkaKarapaceSchemaRegistryDetailsV2) <= 1 items

Adds the specified version of Kafka Karapace Schema Registry to this Kafka cluster.

Array of objects (KafkaRestProxyDetailsV2) <= 1 items

Adds the specified version of Kafka REST Proxy to this Kafka cluster.

clientToClusterEncryption
required
boolean

Enables Client ⇄ Cluster Encryption.

required
Array of objects (KafkaDataCentreV2) = 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"
Array of objects (KafkaDedicatedZookeeperSettingsV2) <= 1 items

Provision additional dedicated nodes for Apache Zookeeper to run on. Zookeeper nodes will be co-located with Kafka if this is not provided

privateNetworkCluster
required
boolean

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

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

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

  • 3.0.2
  • 3.1.2
  • 2.8.2

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

Name of the cluster.

bundledUseOnly
boolean

Provision this cluster for Bundled Use only.

clientAuthBrokerWithEncryption
boolean

Enables Client ⇄ Broker Authentication with Encryption.

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 Cluster provisioning requested.

post/cluster-management/v2/resources/applications/kafka/clusters/v2
Request samples
application/json
{
  • "allowDeleteTopics": true,
  • "autoCreateTopics": true,
  • "clientToClusterEncryption": true,
  • "dataCentres": [
    ],
  • "dedicatedZookeeper": [
    ],
  • "defaultNumberOfPartitions": 3,
  • "defaultReplicationFactor": 3,
  • "kafkaVersion": "[x.y.z]",
  • "name": "MyKafkaCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION"
}
Response samples
application/json
{
  • "allowDeleteTopics": true,
  • "autoCreateTopics": true,
  • "clientToClusterEncryption": true,
  • "dataCentres": [
    ],
  • "dedicatedZookeeper": [
    ],
  • "defaultNumberOfPartitions": 3,
  • "defaultReplicationFactor": 3,
  • "kafkaVersion": "[x.y.z]",
  • "name": "MyKafkaCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION"
}

Get Kafka cluster details.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Responses
200

Kafka cluster details retrieved.

get/cluster-management/v2/resources/applications/kafka/clusters/v2/{clusterId}
Request samples
Response samples
application/json
{
  • "allowDeleteTopics": true,
  • "autoCreateTopics": true,
  • "clientToClusterEncryption": true,
  • "dataCentres": [
    ],
  • "dedicatedZookeeper": [
    ],
  • "defaultNumberOfPartitions": 3,
  • "defaultReplicationFactor": 3,
  • "kafkaVersion": "[x.y.z]",
  • "name": "MyKafkaCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION"
}

Update Kafka Cluster Details

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Request Body schema: application/json
required
Array of objects (KafkaDataCentreV2) = 1 items

List of data centre settings.

Array of objects (KafkaDedicatedZookeeperSettingsUpdateV2) <= 1 items

Provision additional dedicated nodes for Apache Zookeeper to run on. Zookeeper nodes will be co-located with Kafka if this is not provided

Responses
202

Kafka cluster update request accepted.

404

Kafka cluster not found

put/cluster-management/v2/resources/applications/kafka/clusters/v2/{clusterId}
Request samples
application/json
{
  • "dataCentres": [
    ],
  • "dedicatedZookeeper": [
    ]
}
Response samples
application/json
{
  • "allowDeleteTopics": true,
  • "autoCreateTopics": true,
  • "clientToClusterEncryption": true,
  • "dataCentres": [
    ],
  • "dedicatedZookeeper": [
    ],
  • "defaultNumberOfPartitions": 3,
  • "defaultReplicationFactor": 3,
  • "kafkaVersion": "[x.y.z]",
  • "name": "MyKafkaCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION"
}

Delete cluster

Delete an active cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Responses
204

Cluster delete requested.

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