Skip to main content
POST
Create a Managed Kafka cluster

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Body

application/json
allowedCIDRs
string[]
required

Client IP ranges allowed to reach the cluster. Empty allows any IP; clients still need the password.

brokers
integer
default:3
required
Required range: 3 <= x <= 30
instanceType
enum<string>
default:r8g.large
required
Available options:
m8g.2xlarge,
m8g.4xlarge,
m8g.xlarge,
m8i.2xlarge,
m8i.4xlarge,
m8i.xlarge,
r8g.2xlarge,
r8g.large,
r8g.xlarge,
r8i.2xlarge,
r8i.large,
r8i.xlarge
name
string
required

The cluster's name, as customers see it. 3 to 100 characters. The cluster's ID, which its address and Kubernetes objects use, is generated.

Required string length: 3 - 100
region
string
required
storageGiB
integer
required

Disk per broker in GiB: 20, 50 or 80, or any size from 100 to 1024 (1 TiB). Bigger sizes go through support.

Required range: 20 <= x <= 1024
tieredStorage
boolean
required

Whether Artie turns tiered storage on for every topic that hasn't set it either way. The setup form starts it on.

localRetentionBytes
null | integer

Disk cap per partition: the most broker disk each partition of a tiered topic keeps, in bytes, at least 1073741824 (1 GiB). Null is no cap.

localRetentionMS
null | integer

Days on disk: how long tiered topics keep data on broker disks, in ms, from 86400000 (one day) to 1209600000 (14 days). Every topic that doesn't set log.local.retention.ms inherits it. Left out is 3 days.

storageAutoscale
object

How Artie grows the brokers' disks before they fill. Left out is on, growing at 65% to 55%, with no limit.

Response

OK

cloud
string
required
createdAt
string<date-time>
required
disableTLS
boolean
required
externalBootstrapURL
string
required
isManaged
boolean
required

Whether this is a Managed Kafka cluster that Artie runs for the company.

name
string
required
region
string
required
status
enum<string>
required
Available options:
draft,
active,
deploying,
failed,
deleted
tierAllTopics
boolean
required

Whether Artie turns tiered storage on for every topic of a Managed Kafka cluster that doesn't choose otherwise.

tieredStorageAvailable
boolean
required

Whether tiered storage is available on this cluster. Artie turns it on once the cluster's brokers have tiered storage.

updatedAt
string<date-time>
required

When the cluster row last changed. A deploying cluster can be retried 20 minutes after this.

usesScram
boolean
required
uuid
string<uuid>
required
dataKeptUntil
string<date-time>

When a deleted Managed Kafka cluster's data is deleted for good. It can be restored until then. Only set while status is deleted.

deployStage
enum<string>

The step a Managed Kafka cluster's deploy is on. Only set while status is deploying, or failed, where it is the step the deploy stopped at.

Available options:
applying_custom_resources,
issuing_tls_certificate,
provisioning_broker_nodes,
starting_kafka_brokers,
creating_load_balancer
localRetentionBytes
null | integer

Disk cap per partition: the most broker disk each partition of the cluster's tiered topics keeps, in bytes (log.local.retention.bytes). Missing when there is no cap.

localRetentionMS
null | integer

Days on disk: how long the cluster's tiered topics keep data on broker disks, in ms (log.local.retention.ms). Missing on clusters made before it, whose brokers use Kafka's default.

managed
object

A Managed Kafka cluster's configuration. Only set when isManaged, and only by Get a Kafka cluster.

shuttingDown
boolean

Whether a deleted Managed Kafka cluster is still being taken down. It can't be restored until that finishes. Only set in the clusters list.

statusMessage
string

Why the last deploy of a Managed Kafka cluster failed. Only set while status is failed.

storageAutoscale
object

A Managed Kafka cluster's storage autoscaling. Only set when isManaged.

tieredStorageSyncedAt
string<date-time>

When the sync last made a Managed Kafka cluster's topics match the tiered storage choice for each. Missing until its first run.