Sign in

v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01169142751.2 KB
Databases - Essentials

Update Essentials database

Updates the specified Essentials database.

put/v1/fixed/subscriptions/{subscriptionId}/databases/{databaseId}

Path parameters

subscriptionIdinteger required

Subscription ID.

databaseIdinteger required

Database ID.

Request body

subscriptionIdinteger
databaseIdinteger
namestring

Optional. Updated database name.

memoryLimitInGbnumber double

(Pay-as-you-go subscriptions only) Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb.

datasetSizeInGbnumber double

(Pay-as-you-go subscriptions only) Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. If ‘replication’ is 'true', the database’s total memory will be twice as large as the datasetSizeInGb. If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.

supportOSSClusterApiboolean

(Pay-as-you-go subscriptions only) Optional. Support Redis OSS Cluster API.

respVersion'resp2' | 'resp3'

Optional. Redis Serialization Protocol version. Must be compatible with Redis version.

useExternalEndpointForOSSClusterApiboolean

(Pay-as-you-go subscriptions only) Optional. If set to 'true', the database will use the external endpoint for OSS Cluster API. This setting blocks the database's private endpoint. Can only be set if 'supportOSSClusterAPI' is 'true'. Default: 'false'

enableDatabaseClusteringboolean

(Pay-as-you-go subscriptions only) Optional. Distributes database data to different cloud instances.

numberOfShardsinteger

(Pay-as-you-go subscriptions only) Optional. Changes the number of master shards.

dataPersistence'none' | 'aof-every-1-second' | 'aof-every-write' | 'snapshot-every-1-hour' | 'snapshot-every-6-hours' | 'snapshot-every-12-hours'

Optional. Type and rate of data persistence in persistent storage. Use GET /fixed/plans/{planId} to see if your plan supports data persistence.

dataEvictionPolicy'allkeys-lru' | 'allkeys-lfu' | 'allkeys-lrm' | 'allkeys-random' | 'volatile-lru' | 'volatile-lfu' | 'volatile-lrm' | 'volatile-random' | 'volatile-ttl' | 'noeviction'

Optional. Turns database replication on or off.

replicationboolean

Optional. Sets database replication. Use GET /fixed/plans/{planId} to see if your plan supports database replication.

periodicBackupPathstring

Optional. Changes the backup location path. If specified, the database will back up every 24 hours to this location, and you can manually back up the database to this location at any time. Use GET /fixed/plans/{planId} to see if your plan supports database backups. If set to an empty string, the backup path will be removed.

sourceIpsstring[]

Optional. List of source IP addresses or subnet masks to allow. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: '['192.168.10.0/32', '192.168.12.0/24']'

replicaOfstring[]

Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380'] ).

regexRulesstring[]

(Pay-as-you-go subscriptions only) Optional. Hashing policy Regex rules. Used only if 'shardingType' is 'custom-regex-rules'.

clientSslCertificatestring

Optional. A public key client TLS/SSL certificate with new line characters replaced with '\n'. If specified, mTLS authentication will be required to authenticate user connections if it is not already required. If set to an empty string, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of 'enableTls'.

enableTlsboolean

Optional. When 'true', requires TLS authentication for all connections - mTLS with valid clientTlsCertificates, regular TLS when clientTlsCertificates is not provided. If enableTls is set to 'false' while mTLS is required, it will remove the mTLS requirement and erase previously provided clientTlsCertificates.

passwordstring

Optional. Changes the password used to access the database with the 'default' user.

enableDefaultUserboolean

Optional. When 'true', allows connecting to the database with the 'default' user. When 'false', only defined access control users can connect to the database.

commandTypestring

Example request

{
  "name": "Redis-Essentials-database-example",
  "memoryLimitInGb": 1,
  "datasetSizeInGb": 1,
  "supportOSSClusterApi": true,
  "respVersion": "resp3",
  "useExternalEndpointForOSSClusterApi": true,
  "numberOfShards": 2,
  "periodicBackupPath": "s3://<backup-path>",
  "alerts": [
    {
      "name": "dataset-size",
      "value": 80
    }
  ]
}

Response

OK

taskIdstring uuid
commandTypestring
status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'
descriptionstring
timestampstring date-time
linksobject[]