POST
/
v2
/
redis
/
rename
/
{id}
curl -X POST \
  https://api.upstash.com/v2/redis/rename/:id \
  -u 'EMAIL:API_KEY'
  -d '{"name":"MyRedis_new_name"}'

{
  "database_id": 96ad0856-03b1-4ee7-9666-e81abd0349e1,
  "database_name": "MyRedis_new_name",
  "database_type": "Pay as You Go",
  "region": "global",
  "type": "paid",
  "primary_members": [
    "eu-central-1"
  ],
  "all_members": [
    "eu-central-1"
  ],
  "primary_region": "eu-central-1",
  "port": 6379,
  "creation_time": 1727087321,
  "budget": 100,
  "state": "active",
  "password": “***”,
  "user_email": “a**@upstash.com",
  "endpoint": “all-foxe-22421.upstash.io",
  "tls": true,
  "eviction": true,
  "auto_upgrade": false,
  "consistent": false,
  "reserved_per_region_price": 0,
  "next_daily_backup_time": 1741120356,
  "modifying_state": "",
  "rest_token": “***”,
  "read_only_rest_token": “***”,
  "db_max_clients": 1000,
  "db_max_request_size": 1048576,
  "db_resource_size": "L",
  "db_type": "pebble",
  "db_disk_threshold": 107374182400,
  "db_max_entry_size": 104857600,
  "db_memory_threshold": 3221225472,
  "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_max_commands_per_second": 1000,
  "db_request_limit": 9223372036854776000,
  "db_eviction": true,
  "db_acl_enabled": "false",
  "db_acl_default_user_status": "true"
}

​
URL Parameters

​
id
string
required

The ID of the database to be renamed

​
Request Parameters

​
name
string
required

The new name of the database

​
Response Parameters

​
database_id
string

ID of the created database

​
database_name
string

New 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

​
primary_members
array<string>

List of primary regions in the database cluster

​
all_members
array<string>

List of all regions in the database cluster

​
primary_region
string

Primary region of the database cluster

​
port
int

Database port for clients to connect

​
creation_time
int

Creation time of the database as Unix time

​
budget
int

Allocated budget for database operations

​
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

​
eviction
boolean

Whether entry eviction is enabled

​
auto_upgrade
boolean

Automatic upgrade capability status

​
consistent
boolean

Strong consistency mode status

​
reserved_per_region_price
int

Reserved price per region for enterprise plans

​
next_daily_backup_time
int

Unix timestamp of next scheduled backup

​
modifying_state
string

Database state

​
rest_token
string

Full-access REST token

​
read_only_rest_token
string

Read-only REST token

​
db_max_clients
int

Maximum allowed concurrent client connections

​
db_max_request_size
int

Maximum request size in bytes

​
db_resource_size
string

Resource allocation tier

​
db_type
string

Database storage engine type

​
db_disk_threshold
int

Disk storage limit in bytes

​
db_max_entry_size
int

Maximum entry size in bytes

​
db_memory_threshold
int

Memory usage limit in bytes

​
db_conn_idle_timeout
int

Connection idle timeout in nanoseconds

​
db_lua_timeout
int

Lua script execution timeout in nanoseconds

​
db_lua_credits_per_min
int

Lua script execution credits per minute

​
db_store_max_idle
int

Store connection idle timeout in nanoseconds

​
db_max_loads_per_sec
int

Maximum load operations per second

​
db_max_commands_per_second
int

Maximum commands processed per second

​
db_request_limit
int

Maximum allowed requests

​
db_eviction
boolean

Database-level eviction policy status

​
db_acl_enabled
boolean

Access Control List enablement status

​
db_acl_default_user_status
boolean

Default user access status in ACL

curl -X POST \
  https://api.upstash.com/v2/redis/rename/:id \
  -u 'EMAIL:API_KEY'
  -d '{"name":"MyRedis_new_name"}'

{
  "database_id": 96ad0856-03b1-4ee7-9666-e81abd0349e1,
  "database_name": "MyRedis_new_name",
  "database_type": "Pay as You Go",
  "region": "global",
  "type": "paid",
  "primary_members": [
    "eu-central-1"
  ],
  "all_members": [
    "eu-central-1"
  ],
  "primary_region": "eu-central-1",
  "port": 6379,
  "creation_time": 1727087321,
  "budget": 100,
  "state": "active",
  "password": “***”,
  "user_email": “a**@upstash.com",
  "endpoint": “all-foxe-22421.upstash.io",
  "tls": true,
  "eviction": true,
  "auto_upgrade": false,
  "consistent": false,
  "reserved_per_region_price": 0,
  "next_daily_backup_time": 1741120356,
  "modifying_state": "",
  "rest_token": “***”,
  "read_only_rest_token": “***”,
  "db_max_clients": 1000,
  "db_max_request_size": 1048576,
  "db_resource_size": "L",
  "db_type": "pebble",
  "db_disk_threshold": 107374182400,
  "db_max_entry_size": 104857600,
  "db_memory_threshold": 3221225472,
  "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_max_commands_per_second": 1000,
  "db_request_limit": 9223372036854776000,
  "db_eviction": true,
  "db_acl_enabled": "false",
  "db_acl_default_user_status": "true"
}

Was this page helpful?

Suggest editsRaise issue