List Kafka Clusters

This endpoint lists all kafka clusters of user.

GET https://api.upstash.com/v2/kafka/clusters

Try it

curl

curl -X GET \
  https://api.upstash.com/v2/kafka/clusters \
  -u 'EMAIL:API_KEY'

200 OK

[
    {
        "cluster_id": "9bc0e897-cbd3-4997-895a-fd77ad00aec9",
        "name": "test_kafka_cluster",
        "region": "eu-west-1",
        "type": "paid",
        "multizone": true,
        "tcp_endpoint": "sharing-mastodon-12819-eu1-kafka.upstashdev.com",
        "rest_endpoint": "sharing-mastodon-12819-eu1-rest-kafka.upstashdev.com",
        "state": "active",
        "username": "c2hhcmluZy1tYXN0b2Rvbi0xMjgxOSRV1ipriSBOwd0PHzw2KAs_cDrTXzvUKIs",
        "password": "zlQgc0nbgcqF6MxOqnh7tKjJsGnSgLFS89uS-FXzMVqhL2dgFbmHwB-IXAAsOYXzUYj40g==",
        "max_retention_size": 1073741824000,
        "max_retention_time": 2592000000,
        "max_messages_per_second": 1000,
        "creation_time": 1643978975,
        "max_message_size": 1048576,
        "max_partitions": 100
    }
]

Response Parameters

cluster_id · string

ID of the created kafka cluster

name · string

Name of the kafka cluster

region · string

The region the kafka cluster is deployed in

type · string

Shows whether the cluster is free or paid

multizone · boolean

Whether the multizone replication is enabled for the cluster or not

tcp_endpoint · string

TCP endpoint to connect to the kafka cluster

rest_endpoint · string

REST endpoint to connect to the kafka cluster

state · string

Current state of the cluster(active, deleted)

username · string

Username to be used in authenticating to the cluster

password · string

Password to be used in authenticating to the cluster

max_retention_size · int

Max retention size will be allowed to topics in the cluster

max_retention_time · int

Max retention time will be allowed to topics in the cluster

max_messages_per_second · int

Max messages allowed to be produced per second

creation_time · int

Cluster creation timestamp

max_message_size · int

Max message size will be allowed in topics in the cluster

max_partitions · int

Max total number of partitions allowed in the cluster

curl

curl -X GET \
  https://api.upstash.com/v2/kafka/clusters \
  -u 'EMAIL:API_KEY'

200 OK

[
    {
        "cluster_id": "9bc0e897-cbd3-4997-895a-fd77ad00aec9",
        "name": "test_kafka_cluster",
        "region": "eu-west-1",
        "type": "paid",
        "multizone": true,
        "tcp_endpoint": "sharing-mastodon-12819-eu1-kafka.upstashdev.com",
        "rest_endpoint": "sharing-mastodon-12819-eu1-rest-kafka.upstashdev.com",
        "state": "active",
        "username": "c2hhcmluZy1tYXN0b2Rvbi0xMjgxOSRV1ipriSBOwd0PHzw2KAs_cDrTXzvUKIs",
        "password": "zlQgc0nbgcqF6MxOqnh7tKjJsGnSgLFS89uS-FXzMVqhL2dgFbmHwB-IXAAsOYXzUYj40g==",
        "max_retention_size": 1073741824000,
        "max_retention_time": 2592000000,
        "max_messages_per_second": 1000,
        "creation_time": 1643978975,
        "max_message_size": 1048576,
        "max_partitions": 100
    }
]