Sign in

v51

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

Update Active-Active database

(Active-Active databases only) Updates database properties for an Active-Active database.

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

Path parameters

subscriptionIdinteger required

Subscription ID.

databaseIdinteger required

Database ID.

Request body

subscriptionIdinteger
databaseIdinteger
namestring

Optional. Updated database name. Database name is limited to 40 characters or less and must include only letters, digits, and hyphens ('-'). It must start with a letter and end with a letter or digit.

dryRunboolean

Optional. When 'false': Creates a deployment plan and deploys it, updating any resources required by the plan. When 'true': creates a read-only deployment plan and does not update any resources. Default: 'false'

memoryLimitInGbnumber double

Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb.

datasetSizeInGbnumber double

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

Optional. Support Redis OSS Cluster API. Default: 'false'

useExternalEndpointForOSSClusterApiboolean

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'.

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.

globalDataPersistence'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 all regions that don't set local 'dataPersistence'.

globalPasswordstring

Optional. Changes the password used to access the database in all regions that don't set a local 'password'.

globalEnableDefaultUserboolean

Optional. When 'true', allows connecting to the database with the 'default' user in all regions that don't set local 'enableDefaultUser'. When 'false', only defined access control users can connect to the database.

globalSourceIpstring[]

Optional. List of source IP addresses or subnet masks to whitelist in all regions that don't set local 'sourceIp' settings. If set, 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']

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

Optional. Data eviction policy.

autoMinorVersionUpgradeboolean

Optional. Automatically upgrades the database to newer minor versions within the same major release. Applies to version 8.4 and above.

commandTypestring

Example request

{
  "name": "Redis-database-example",
  "memoryLimitInGb": 1,
  "datasetSizeInGb": 1,
  "globalAlerts": [
    {
      "name": "dataset-size",
      "value": 80
    }
  ],
  "regions": [
    {
      "localThroughputMeasurement": {
        "writeOperationsPerSecond": 1000,
        "readOperationsPerSecond": 1000
      },
      "password": "P@ssw0rd",
      "alerts": [
        {
          "name": "dataset-size",
          "value": 80
        }
      ],
      "respVersion": "resp3"
    }
  ]
}

Response

OK

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