Sign in

v51

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

Add region to Active-Active subscription

Adds a new region to an Active-Active subscription.

post/v1/subscriptions/{subscriptionId}/regions

Path parameters

subscriptionIdinteger required

Subscription ID.

Request body

subscriptionIdinteger
regionstring

Name of region to add as defined by the cloud provider.

vpcIdstring

Optional. Enter a VPC identifier that exists in the hosted AWS account. Creates a new VPC if not set. VPC Identifier must be in a valid format and must exist within the hosting account.

deploymentCIDRstring

Deployment CIDR mask. Must be a valid CIDR format with a range of 256 IP addresses.

subnetIdsstring[]

Optional. Enter a list of subnets identifiers that exists in the hosted AWS account. Subnet Identifier must exist within the hosting account.

securityGroupIdstring

Optional. Enter a security group identifier that exists in the hosted AWS account. Security group Identifier must be in a valid format (for example: 'sg-0125be68a4625884ad') and must exist within the hosting account.

multipleAvailabilityZonesboolean

Optional. Support deployment on multiple availability zones within the selected region. When omitted, defaults to true unless the region is explicitly marked as not supporting multi-AZ.

preferredAvailabilityZonesstring[]

Optional. List the zone IDs for your preferred availability zones for the cloud provider and region.

dryRunboolean

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

respVersion'resp2' | 'resp3'

Optional. RESP version must be compatible with Redis version.

customerManagedKeyResourceNamestring

Required for subscriptions where 'persistentStorageEncryptionType' is 'customer-managed-key'. The resource name of the customer-managed encryption key for the region.

commandTypestring

Example request

{
  "vpcId": "vpc-0125be68a4625884ad",
  "deploymentCIDR": "10.0.0.0/24",
  "subnetIds": [
    "['subnet-0125be68a4625884ad', 'subnet-0125be68a4625884ad','subnet-0125be68a4625884ad']"
  ],
  "securityGroupId": "sg-0125be68a4625884ad",
  "databases": [
    {
      "localThroughputMeasurement": {
        "writeOperationsPerSecond": 1000,
        "readOperationsPerSecond": 1000
      }
    }
  ],
  "respVersion": "resp3",
  "customerManagedKeyResourceName": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"
}

Response

OK

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