Skip to main content
PUT
Change a Managed Kafka cluster's allowlist

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string
required

Body

application/json
allowedCIDRs
string[]
required

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

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.