Rename a Kafka cluster
Changes the name a Managed Kafka cluster, or one on the company’s BYOC data plane, shows in the dashboard. Its bootstrap address, Kubernetes objects, and MSK cluster keep the name it was created with. Company admins only.
Authorizations
API key passed as a Bearer token in the Authorization header.
Path Parameters
Body
The cluster's new name, as customers see it. 3 to 100 characters.
3 - 100Response
OK
Whether this is a Managed Kafka cluster that Artie runs for the company.
draft, active, deploying, failed, deleted Whether Artie turns tiered storage on for every topic of a Managed Kafka cluster that doesn't choose otherwise.
Whether tiered storage is available on this cluster. Artie turns it on once the cluster's brokers have tiered storage.
When the cluster row last changed. A deploying cluster can be retried 20 minutes after this.
When a deleted Managed Kafka cluster's data is deleted for good. It can be restored until then. Only set while status is deleted.
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.
applying_custom_resources, issuing_tls_certificate, provisioning_broker_nodes, starting_kafka_brokers, creating_load_balancer 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.
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.
A Managed Kafka cluster's configuration. Only set when isManaged, and only by Get a Kafka cluster.
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.
Why the last deploy of a Managed Kafka cluster failed. Only set while status is failed.
A Managed Kafka cluster's storage autoscaling. Only set when isManaged.
When the sync last made a Managed Kafka cluster's topics match the tiered storage choice for each. Missing until its first run.

