Skip to main content
post/redis/enable-tls/{id}
Request example
Response
post/redis/enable-tls/{id}

Authorization

Authorizationstringheaderrequired#
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded username:password.

Path parameters

idstringrequired#
The ID of the database to enable TLS

Responses

application/json
200
TLS enabled successfully
database_idstring#
ID of the database

Example:"96ad0856-03b1-4ee7-9666-e81abd0349e1"

database_namestring#
Name of the database

Example:"MyRedis"

database_typestring#
Pricing model of the database, one of free, Pay as You Go or Enterprise

Example:"Pay as You Go"

regionenum<string>#
The region where database is hosted
Options:global

Example:"global"

portinteger#
Database port for clients to connect

Example:6379

creation_timeinteger#
Creation time of the database as Unix time

Example:1752649602

stateenum<string>#
State of database
Options:activesuspendedpassive

Example:"active"

endpointstring#
Endpoint identifier or hostname of the database (may be a slug like "beloved-stallion-58500" or a full host)

Example:"beloved-stallion-58500"

rest_tokenstring#
REST token for the database. Omitted when credential protection is on, when you pass the credentials=hide query parameter to Get Database, or when the API key or your team role is read-only.
read_only_rest_tokenstring#
Read-only REST token for the database. Omitted when credential protection is on, or when you pass the credentials=hide query parameter to Get Database.
passwordstring#
Password of the database. Omitted when credential protection is on, when you pass the credentials=hide query parameter to Get Database, or when the API key or your team role is read-only.
tlsboolean#
TLS/SSL is enabled or not

Example:true

db_daily_bandwidth_limitinteger#
Daily bandwidth limit for the database (in bytes). The response can omit this field.
db_max_clientsinteger#
Max number of concurrent clients can be opened on this database currently

Example:10000

db_max_request_sizeinteger#
Max size of a request that will be accepted by the database currently(in bytes)

Example:10485760

db_disk_thresholdinteger#
Total disk size limit that can be used for the database currently(in bytes)

Example:107374182400

db_max_entry_sizeinteger#
Max size of an entry that will be accepted by the database currently(in bytes)

Example:104857600

db_memory_thresholdinteger#
Max size of a memory the database can use(in bytes)

Example:3221225472

db_max_commands_per_secondinteger#
Max number of commands can be sent to the database per second

Example:10000

db_request_limitinteger#
Total number of commands can be sent to the database

Example:8024278031528737000

typeenum<string>#
Payment plan of the database
Options:freepaygpropaid

Example:"paid"

budgetinteger#
Allocated monthly budget for the database

Example:360

primary_regionenum<string>#
Primary region of the database cluster
Options:us-east-1us-east-2us-west-1us-west-2ca-central-1eu-central-1eu-west-1eu-west-2sa-east-1ap-south-1ap-northeast-1ap-southeast-1ap-southeast-2af-south-1us-central1us-east4europe-west1asia-northeast1

Example:"us-east-1"

primary_membersstring[]#
List of primary regions in the database cluster
Example:
all_membersstring[]#
List of all regions in the database cluster
Example:
evictionboolean#
Entry eviction is enabled

Example:false

auto_upgradeboolean#
Automatic upgrade capability is enabled

Example:false

consistentboolean#
Strong consistency mode is enabled

Example:false

modifying_statestring#
Current modifying state of the database

Example:""

db_resource_sizeenum<string>#
Resource allocation tier
Options:SMLXLXXL3XL

Example:"L"

db_typeenum<string>#
Database storage engine type
Options:boltbadgerpebble

Example:"pebble"

db_conn_idle_timeoutinteger#
Connection idle timeout in nanoseconds

Example:21600000000000

db_lua_timeoutinteger#
Lua script execution timeout in nanoseconds

Example:250000000

db_lua_credits_per_mininteger#
Lua script execution credits per minute

Example:10000000000

db_store_max_idleinteger#
Store connection idle timeout in nanoseconds

Example:900000000000

db_max_loads_per_secinteger#
Maximum load operations per second

Example:1000000

db_acl_enabledenum<string>#
Access Control List enabled status
Options:truefalse

Example:"false"

db_acl_default_user_statusenum<string>#
Default user access status in ACL
Options:truefalse

Example:"true"

db_evictionboolean#
Database-level eviction policy status

Example:false

last_plan_upgrade_timeinteger#
Unix timestamp of the last plan upgrade

Example:0

replicasinteger#
Replica factor of the database

Example:5

user_emailstring#
Owner identifier of the database (may be email or marketplace-scoped email)

Example:"example@upstash.com"

daily_backup_enabledboolean#
Whether daily backup is enabled

Example:false

read_regionsstring[]#
Array of read regions of the database
Example:
securityAddonsobject#
Security add-ons and their enablement status
Example:
prometheus_enabledenum<string>#
Prometheus integration enabled status
Options:truefalse

Example:"false"

prod_pack_enabledboolean#
Production pack enabled status

Example:false