Create Redis Database
This endpoint creates a new Redis database.
curl --request POST \
--url https://api.upstash.com/v2/redis/database \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"database_name": "myredis",
"platform": "aws",
"primary_region": "us-east-1",
"read_regions": [
"us-west-1",
"us-west-2"
],
"plan": "payg",
"budget": 360
}'{
"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": "example@upstash.com",
"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
}Authorization
Bearer authentication header of the form Bearer <token>.
Body
Name of the database
Desired cloud platform for the database.
Primary Region of the Global Database
Array of Read Regions of the Database
Specifies the fixed plan type for the database. If omitted, the database defaults to either the pay-as-you-go or free plan, based on the account type.
Monthly budget of the database
Whether to enable eviction for the database
Whether to enable TLS for the database
Response
200 — Database created successfully
ID of the database
Name of the database
The region where database is hosted
Database port for clients to connect
Creation time of the database as Unix time
State of database
Endpoint identifier or hostname of the database (may be a slug like "beloved-stallion-58500" or a full host)
TLS/SSL is enabled or not
Max number of concurrent clients can be opened on this database currently
Max size of a request that will be accepted by the database currently(in bytes)
Total disk size limit that can be used for the database currently(in bytes)
Max size of an entry that will be accepted by the database currently(in bytes)
Max size of a memory the database can use(in bytes)
Max number of commands can be sent to the database per second
Total number of commands can be sent to the database
Payment plan of the database
Allocated monthly budget for the database
Primary region of the database cluster
List of primary regions in the database cluster
List of all regions in the database cluster
Entry eviction is enabled
Automatic upgrade capability is enabled
Strong consistency mode is enabled
Current modifying state of the database
Resource allocation tier
Database storage engine type
Connection idle timeout in nanoseconds
Lua script execution timeout in nanoseconds
Lua script execution credits per minute
Store connection idle timeout in nanoseconds
Maximum load operations per second
Access Control List enabled status
Default user access status in ACL
Database-level eviction policy status
Unix timestamp of the last plan upgrade
Replica factor of the database
Owner identifier of the database (may be email or marketplace-scoped email)
Whether daily backup is enabled
Array of read regions of the database
Security add-ons and their enablement status
Prometheus integration enabled status
Production pack enabled status