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

{
  "database_id": "96ad0856-03b1-4ee7-9666-e81abd0349e1",
  "database_name": "MyRedis",
  "database_type": "Pay as You Go",
  "region": "eu-central-1",
  "port": 30143,
  "creation_time": 1658909671,
  "state": "active",
  "password": "038a8e27c45e43068d5f186085399884",
  "user_email": "example@upstash.com",
  "endpoint": "eu2-sought-mollusk-30143.upstash.io",
  "tls": true,
  "rest_token": "AXW_ASQgOTZhZDA4NTYtMDNiMS00ZWU3LTk2NjYtZTgxYWJkMDM0OWUxMDM4YThlMjdjNDVlNDMwNjhkNWYxODYwODUzOTk4ODQ=",
  "read_only_rest_token": "AnW_ASQgOTZhZDA4NTYtMDNiMS00ZWU3LTk2NjYtZTgxYWJkMDM0OWUx8sbmiEcMm9u7Ks5Qx-kHNiWr_f-iUXSIH8MlziKMnpY=",
  "db_max_clients": 1000,
  "db_max_request_size": 1048576,
  "db_disk_threshold": 107374182400,
  "db_max_entry_size": 104857600,
  "db_memory_threshold": 1073741824,
  "db_daily_bandwidth_limit": 53687091200,
  "db_max_commands_per_second": 1000,
  "db_request_limit": 9223372036854775808
}

​
Request

​
id
string
required
The ID of the database to reset password
​
credentials
string
Set to hide to remove credentials from the response.

​
Response

​
database_id
string
ID of the created database
​
database_name
string
Name of the database
​
database_type
string
Type of the database in terms of pricing model(Free, Pay as You Go or Enterprise)
​
region
string
The region where database is hosted
​
port
int
Database port for clients to connect
​
creation_time
int
Creation time of the database as Unix time
​
state
string
State of database (active or deleted)
​
password
string
Password of the database
​
user_email
string
Email or team id of the owner of the database
​
endpoint
string
Endpoint URL of the database
​
tls
boolean
TLS/SSL is enabled or not
​
rest_token
string
Token for rest based communication with the database
​
read_only_rest_token
string
Read only token for rest based communication with the database
​
db_max_clients
int
Max number of concurrent clients can be opened on this database currently
​
db_max_request_size
int
Max size of a request that will be accepted by the database currently(in bytes)
​
db_disk_threshold
int
Total disk size limit that can be used for the database currently(in bytes)
​
db_max_entry_size
int
Max size of an entry that will be accepted by the database currently(in bytes)
​
db_memory_threshold
int
Max size of a memory the database can use(in bytes)
​
db_daily_bandwidth_limit
int
Max daily bandwidth can be used by the database(in bytes)
​
db_max_commands_per_second
int
Max number of commands can be sent to the database per second
​
db_request_limit
int
Total number of commands can be sent to the database
curl -X GET \
  https://api.upstash.com/v2/redis/database/:id \
  -u 'EMAIL:API_KEY'

{
  "database_id": "96ad0856-03b1-4ee7-9666-e81abd0349e1",
  "database_name": "MyRedis",
  "database_type": "Pay as You Go",
  "region": "eu-central-1",
  "port": 30143,
  "creation_time": 1658909671,
  "state": "active",
  "password": "038a8e27c45e43068d5f186085399884",
  "user_email": "example@upstash.com",
  "endpoint": "eu2-sought-mollusk-30143.upstash.io",
  "tls": true,
  "rest_token": "AXW_ASQgOTZhZDA4NTYtMDNiMS00ZWU3LTk2NjYtZTgxYWJkMDM0OWUxMDM4YThlMjdjNDVlNDMwNjhkNWYxODYwODUzOTk4ODQ=",
  "read_only_rest_token": "AnW_ASQgOTZhZDA4NTYtMDNiMS00ZWU3LTk2NjYtZTgxYWJkMDM0OWUx8sbmiEcMm9u7Ks5Qx-kHNiWr_f-iUXSIH8MlziKMnpY=",
  "db_max_clients": 1000,
  "db_max_request_size": 1048576,
  "db_disk_threshold": 107374182400,
  "db_max_entry_size": 104857600,
  "db_memory_threshold": 1073741824,
  "db_daily_bandwidth_limit": 53687091200,
  "db_max_commands_per_second": 1000,
  "db_request_limit": 9223372036854775808
}