POST
/
v2
/
kafka
/
topic
curl -X POST \
  https://api.upstash.com/v2/kafka/topic \
  -u 'EMAIL:API_KEY' \
  -d '{"name":"test-kafka-topic","partitions":1,"retention_time":1234,"retention_size":4567,"max_message_size":8912,"cleanup_policy":"delete","cluster_id":"9bc0e897-cbd3-4997-895a-fd77ad00aec9"}'
{
    "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": 4567,
    "retention_time": 1234,
    "max_message_size": 8912
}

Request Parameters

name
string
required
Name of the new kafka topic
partitions
int
required
The number of partitions the topic will have
retention_time
int
required
Retention time of messsages in the topic -1 for highest possible value
retention_size
int
required
Retention size of the messages in the topic -1 for highest possible value
max_message_size
int
required
Max message size in the topic -1 for highest possible value
cleanup_policy
string
required
Cleanup policy will be used in the topic compact or delete
cluster_id
string
required
ID of the cluster the topic will be deployed in

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
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 -X POST \
  https://api.upstash.com/v2/kafka/topic \
  -u 'EMAIL:API_KEY' \
  -d '{"name":"test-kafka-topic","partitions":1,"retention_time":1234,"retention_size":4567,"max_message_size":8912,"cleanup_policy":"delete","cluster_id":"9bc0e897-cbd3-4997-895a-fd77ad00aec9"}'
{
    "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": 4567,
    "retention_time": 1234,
    "max_message_size": 8912
}