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

{
    "cluster_id": "9bc0e897-cbd3-4997-895a-fd77ad00aec9",
    "name": "mykafkacluster-2",
    "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": "7ea02715ceeb4fd3ba1542a5f3bf758e",
    "max_retention_size": 1073741824000,
    "max_retention_time": 2592000000,
    "max_messages_per_second": 1000,
    "creation_time": 1643978975,
    "max_message_size": 1048576,
    "max_partitions": 100
}

​
URL Parameters

​
id
string
required
The ID of the Kafka cluster to reset password

​
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 -X POST \
  https://api.upstash.com/v2/kafka/reset-password/:id \
  -u 'EMAIL:API_KEY'

{
    "cluster_id": "9bc0e897-cbd3-4997-895a-fd77ad00aec9",
    "name": "mykafkacluster-2",
    "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": "7ea02715ceeb4fd3ba1542a5f3bf758e",
    "max_retention_size": 1073741824000,
    "max_retention_time": 2592000000,
    "max_messages_per_second": 1000,
    "creation_time": 1643978975,
    "max_message_size": 1048576,
    "max_partitions": 100
}