Skip to main content
GET
/
redis
/
database
/
{id}
Get Database
curl --request GET \
  --url https://api.upstash.com/v2/redis/database/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "database_id": "96ad0856-03b1-4ee7-9666-e81abd0349e1",
  "database_name": "MyRedis",
  "region": "global",
  "port": 6379,
  "creation_time": 1752649602,
  "state": "active",
  "endpoint": "beloved-stallion-58500",
  "tls": true,
  "db_max_clients": 10000,
  "db_max_request_size": 10485760,
  "db_disk_threshold": 107374182400,
  "db_max_entry_size": 104857600,
  "db_memory_threshold": 3221225472,
  "db_max_commands_per_second": 10000,
  "db_request_limit": 8024278031528737000,
  "type": "paid",
  "budget": 360,
  "primary_region": "us-east-1",
  "primary_members": [
    "us-east-1"
  ],
  "all_members": [
    "us-east-1"
  ],
  "eviction": false,
  "auto_upgrade": false,
  "consistent": false,
  "modifying_state": "",
  "db_resource_size": "L",
  "db_type": "pebble",
  "db_conn_idle_timeout": 21600000000000,
  "db_lua_timeout": 250000000,
  "db_lua_credits_per_min": 10000000000,
  "db_store_max_idle": 900000000000,
  "db_max_loads_per_sec": 1000000,
  "db_acl_enabled": "false",
  "db_acl_default_user_status": "true",
  "db_eviction": false,
  "last_plan_upgrade_time": 0,
  "replicas": 5,
  "customer_id": "[email protected]",
  "daily_backup_enabled": false,
  "read_regions": [
    "us-east-2"
  ],
  "securityAddons": {
    "ipWhitelisting": false,
    "vpcPeering": false,
    "privateLink": false,
    "tlsMutualAuth": false,
    "encryptionAtRest": false
  },
  "prometheus_enabled": "false",
  "prod_pack_enabled": false
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

Query Parameters

​
credentials
string

Response

200 - application/json
​
database_id
string
Example:
​
database_name
string
Example:
​
region
enum<string>
Available options:
global
Example:
​
port
integer
Example:
​
creation_time
integer
Example:
​
state
enum<string>
Available options:
active,
suspended,
passive
Example:
​
endpoint
string
Example:
​
tls
boolean
Example:
​
db_max_clients
integer
Example:
​
db_max_request_size
integer
Example:
​
db_disk_threshold
integer
Example:
​
db_max_entry_size
integer
Example:
​
db_memory_threshold
integer
Example:
​
db_max_commands_per_second
integer
Example:
​
db_request_limit
integer
Example:
​
type
enum<string>
Available options:
free,
payg,
pro,
paid
Example:
​
budget
integer
Example:
​
primary_region
enum<string>
Available options:
ap-south-1,
ap-southeast-1,
ap-southeast-2,
ap-northeast-1,
eu-west-1,
eu-west-2,
eu-central-1,
us-east-1,
us-west-1,
us-west-2,
us-east-2,
sa-east-1,
ca-central-1
Example:
​
primary_members
string[]
Example:
​
all_members
string[]
Example:
​
eviction
boolean
Example:
​
auto_upgrade
boolean
Example:
​
consistent
boolean
Example:
​
modifying_state
string
Example:
​
db_resource_size
enum<string>
Available options:
S,
M,
L,
XL,
XXL,
3XL
Example:
​
db_type
enum<string>
Available options:
bolt,
badger,
pebble
Example:
​
db_conn_idle_timeout
integer
Example:
​
db_lua_timeout
integer
Example:
​
db_lua_credits_per_min
integer
Example:
​
db_store_max_idle
integer
Example:
​
db_max_loads_per_sec
integer
Example:
​
db_acl_enabled
enum<string>
Available options:
true,
false
Example:
​
db_acl_default_user_status
enum<string>
Available options:
true,
false
Example:
​
db_eviction
boolean
Example:
​
last_plan_upgrade_time
integer
Example:
​
replicas
integer
Example:
​
customer_id
string
Example:
​
daily_backup_enabled
boolean
Example:
​
read_regions
string[]
Example:
​
securityAddons
object
Example:
​
prometheus_enabled
enum<string>
Available options:
true,
false
Example:
​
prod_pack_enabled
boolean
Example: