List compatible node sizes for Kafka and any specified addon applications.
query Parameters
Successfully retrieved compatible node sizes for Kafka.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
[- {
- "cloudProviderNodeSizes": [
- {
- "nodeSizes": [
- "m5xl-400-v2",
- "r5xl-2000-v2"
], - "cloudProvider": "AWS_VPC",
- "document": "string"
}
]
}
]List all versions of applications compatible with a Kafka version.
Successfully retrieved versions of applications compatible with a Kafka version.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
[- {
- "compatibleVersions": [
- {
- "compatibleApplicationGroup": [
- {
- "application": "[APPLICATION]",
- "version": "1.0.0"
}
]
}
]
}
]List all Kafka applications and versions.
Successfully retrieved applications and versions for Kafka.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
[- {
- "applicationVersions": [
- {
- "application": "[APPLICATION]",
- "versions": [
- "1.0.0",
- "1.0.1"
]
}
]
}
]Download Kafka cluster X.509 Certificate Authority certificates
Kafka cluster certificates are returned as a .zip file. The file contains an X.509 cluster Certificate Authority certificate in JKS file, an X.509 cluster Certificate Authority certificate in PEM-encoded (ASCII) format, and an X.509 cluster Certificate Authority certificate in DER-encoded (binary) format.
Successfully create the Kafka cluster's certificate
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Create a Kafka cluster.
Request Body schema: application/json
| clientBrokerAuthWithMtls | boolean Enables Client ⇄ Broker Authentication with mTLS. |
| defaultNumberOfPartitions required | integer Default number of partitions to use when created new topics. |
Array of objects (KafkaKarapaceRestProxyDetailsV2) <= 1 items Adds the specified version of Kafka Karapace REST Proxy to this Kafka cluster. | |
| autoCreateTopics required | boolean Allows topics to be auto created by brokers when messages are published to a non-existent topic |
| clientToClusterEncryption required | boolean Enables Client ⇄ Cluster Encryption. |
| currentClusterOperationStatus | string (CurrentClusterOperationStatusV2) Indicates if the cluster is currently performing any restructuring operation such as being created or resized |
| 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:
|
| bundledUseOnly | boolean Provision this cluster for Bundled Use only. |
| 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. |
| 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. |
Array of objects (TwoFactorDeleteSettingsV2) <= 1 items | |
| allowDeleteTopics required | boolean Allows topics to be deleted via the kafka-topics tool |
Array of objects (KafkaKarapaceSchemaRegistryDetailsV2) <= 1 items Adds the specified version of Kafka Karapace Schema Registry to this Kafka cluster. | |
Array of objects (KafkaKraftSettingsV2) <= 1 items Create a KRaft Cluster | |
Array of objects (KafkaRestProxyDetailsV2) <= 1 items Adds the specified version of Kafka REST Proxy to this Kafka cluster. | |
required | Array of objects (KafkaDataCentreV2) = 1 items List of data centre settings. |
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 | |
| name required | string [ 3 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]* Name of the cluster. |
Kafka Cluster provisioning requested.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
{- "allowDeleteTopics": true,
- "autoCreateTopics": true,
- "clientToClusterEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "KFK-PRD-r6g.large-250",
- "numberOfNodes": 3,
- "region": "US_EAST_1"
}
], - "dedicatedZookeeper": [
- {
- "zookeeperNodeCount": 3,
- "zookeeperNodeSize": "KDZ-PRD-m6g.large-80"
}
], - "defaultNumberOfPartitions": 3,
- "defaultReplicationFactor": 3,
- "kafkaVersion": "[x.y.z]",
- "name": "MyKafkaCluster",
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION"
}- 202
{- "allowDeleteTopics": true,
- "autoCreateTopics": true,
- "clientToClusterEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "KFK-PRD-r6g.large-250",
- "numberOfNodes": 3,
- "region": "US_EAST_1"
}
], - "dedicatedZookeeper": [
- {
- "zookeeperNodeCount": 3,
- "zookeeperNodeSize": "KDZ-PRD-m6g.large-80"
}
], - "defaultNumberOfPartitions": 3,
- "defaultReplicationFactor": 3,
- "kafkaVersion": "[x.y.z]",
- "name": "MyKafkaCluster",
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION"
}Get Kafka cluster details.
Kafka cluster details retrieved.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
{- "allowDeleteTopics": true,
- "autoCreateTopics": true,
- "clientToClusterEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "KFK-PRD-r6g.large-250",
- "numberOfNodes": 3,
- "region": "US_EAST_1"
}
], - "dedicatedZookeeper": [
- {
- "zookeeperNodeCount": 3,
- "zookeeperNodeSize": "KDZ-PRD-m6g.large-80"
}
], - "defaultNumberOfPartitions": 3,
- "defaultReplicationFactor": 3,
- "kafkaVersion": "[x.y.z]",
- "name": "MyKafkaCluster",
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION"
}Update Kafka Cluster Details
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 |
Kafka cluster update request accepted.
Kafka cluster not found
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
{- "dataCentres": [
- {
- "awsSettings": [
- {
- "ebsEncryptionKey": "9a27373a-0451-4121-94ba-873fc441f313",
- "customVirtualNetworkId": "string"
}
], - "numberOfNodes": 6,
- "network": "192.168.0.0/18",
- "tags": [
- {
- "value": "myTagValue",
- "key": "myTagKey"
}
], - "gcpSettings": [
- {
- "customVirtualNetworkId": "string"
}
], - "nodeSize": "KFK-DEV-t4g.small-5",
- "cloudProvider": "AWS_VPC",
- "azureSettings": [
- {
- "resourceGroup": "string"
}
], - "name": "US_EAST_1_DC",
- "region": "US_EAST_1",
- "privateLink": [
- {
- "advertisedHostname": "test.com"
}
], - "providerAccountName": "string"
}
], - "dedicatedZookeeper": [
- {
- "zookeeperNodeSize": "KDZ-DEV-t4g.small-30"
}
]
}- 202
- 404
{- "allowDeleteTopics": true,
- "autoCreateTopics": true,
- "clientToClusterEncryption": true,
- "dataCentres": [
- {
- "cloudProvider": "AWS_VPC",
- "name": "AWS_VPC_US_EAST_1",
- "network": "10.0.0.0/16",
- "nodeSize": "KFK-PRD-r6g.large-250",
- "numberOfNodes": 3,
- "region": "US_EAST_1"
}
], - "dedicatedZookeeper": [
- {
- "zookeeperNodeCount": 3,
- "zookeeperNodeSize": "KDZ-PRD-m6g.large-80"
}
], - "defaultNumberOfPartitions": 3,
- "defaultReplicationFactor": 3,
- "kafkaVersion": "[x.y.z]",
- "name": "MyKafkaCluster",
- "pciComplianceMode": false,
- "privateNetworkCluster": false,
- "slaTier": "PRODUCTION"
}