GET
/
v2
/
kafka
/
topics
/
{id}
curl -X GET \
  https://api.upstash.com/v2/kafka/topics/:id \
  -u 'EMAIL:API_KEY'

[
    {
        "topic_id": "0f458c88-2dc6-4f69-97bb-05060e0be934",
        "topic_name": "test-kafka-topic",
        "cluster_id": "9bc0e897-cbd3-4997-895a-fd77ad00aec9",
        "region": "eu-west-1",
        "creation_time": 1643981720,
        "state": "active",
        "partitions": 1,
        "multizone": true,
        "tcp_endpoint": "sharing-mastodon-12819-eu1-kafka.upstashdev.com",
        "rest_endpoint": "sharing-mastodon-12819-eu1-rest-kafka.upstashdev.com",
        "username": "c2hhcmluZy1tYXN0b2Rvbi0xMjgxOSRV1ipriSBOwd0PHzw2KAs_cDrTXzvUKIs",
        "password": "eu8K3rYRS-ma0AsINDo7MMemmHjjRSldHJcG3c1LUMZkFfdSf9u_Kd4xCWO9_oQc",
        "cleanup_policy": "delete",
        "retention_size": 4568,
        "retention_time": 1235,
        "max_message_size": 8913
    }
]

​
URL Parameters

​
id
string
required
The ID of the Kafka cluster

​
Response Parameters

​
topic_id
string
ID of the new kafka topic
​
topic_name
string
Name of the new kafka topic
​
cluster_id
string
ID of the created Kafka cluster
​
region
string
The region the Kafka cluster is deployed in
​
creation_time
int
Cluster creation timestamp
​
state
string
State of the topic\ Options: active or deleted
​
partitions
int
Number of partitions the topic has
​
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
​
username
string
Cleanup policy to be used in the topic\ Options: compact or delete
​
password
string
Password to be used in authenticating to the cluster
​
cleanup_policy
int
Max total number of partitions allowed in 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_message_size
int
Max message size will be allowed in topics in the cluster
curl -X GET \
  https://api.upstash.com/v2/kafka/topics/:id \
  -u 'EMAIL:API_KEY'

[
    {
        "topic_id": "0f458c88-2dc6-4f69-97bb-05060e0be934",
        "topic_name": "test-kafka-topic",
        "cluster_id": "9bc0e897-cbd3-4997-895a-fd77ad00aec9",
        "region": "eu-west-1",
        "creation_time": 1643981720,
        "state": "active",
        "partitions": 1,
        "multizone": true,
        "tcp_endpoint": "sharing-mastodon-12819-eu1-kafka.upstashdev.com",
        "rest_endpoint": "sharing-mastodon-12819-eu1-rest-kafka.upstashdev.com",
        "username": "c2hhcmluZy1tYXN0b2Rvbi0xMjgxOSRV1ipriSBOwd0PHzw2KAs_cDrTXzvUKIs",
        "password": "eu8K3rYRS-ma0AsINDo7MMemmHjjRSldHJcG3c1LUMZkFfdSf9u_Kd4xCWO9_oQc",
        "cleanup_policy": "delete",
        "retention_size": 4568,
        "retention_time": 1235,
        "max_message_size": 8913
    }
]