Sign in
Subscriptions - Pro

Create Pro subscription

Creates a new Redis Cloud Pro subscription.

post/subscriptions

Request body

namestring

Optional. New subscription name.

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'

deploymentType'single-region' | 'active-active'

Optional. When 'single-region' or not set: Creates a single region subscription. When 'active-active': creates an Active-Active (multi-region) subscription.

paymentMethod'credit-card' | 'marketplace'

Optional. The payment method for the subscription. If set to ‘credit-card’, ‘paymentMethodId’ must be defined. Default: 'credit-card'

paymentMethodIdinteger

Optional. A valid payment method ID for this account. Use GET /payment-methods to get a list of all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required for all other account types.

memoryStorage'ram' | 'ram-and-flash'

Optional. Memory storage preference: either 'ram' or a combination of 'ram-and-flash' (also known as Auto Tiering). Default: 'ram'

persistentStorageEncryptionType'cloud-provider-managed-key' | 'customer-managed-key'

Optional. Persistent storage encryption secures data-at-rest for database persistence. You can use 'cloud-provider-managed-key' or 'customer-managed-key'. Default: 'cloud-provider-managed-key'

redisVersionstring

Optional. Defines the Redis version of the databases created in this specific request. It doesn't determine future databases associated with this subscription. If not set, databases will use the default Redis version. This field is deprecated and will be removed in a future API version - use the database-level redisVersion property instead.

commandTypestring

Example request

{
  "name": "My new subscription",
  "deploymentType": "single-region",
  "memoryStorage": "ram",
  "persistentStorageEncryptionType": "cloud-provider-managed-key",
  "persistentStorageEncryptionKeys": {
    "customerManagedKeys": [
      {
        "resourceName": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"
      }
    ],
    "deletionGracePeriod": "alerts-only"
  },
  "cloudProviders": [
    {
      "provider": "AWS",
      "cloudAccountId": 1,
      "regions": [
        {
          "region": "us-east-1",
          "networking": {
            "deploymentCIDR": "10.0.0.0/24",
            "vpcId": "<vpc-identifier>"
          }
        }
      ]
    }
  ],
  "databases": [
    {
      "name": "Redis-database-example",
      "port": 10000,
      "memoryLimitInGb": 1,
      "datasetSizeInGb": 1,
      "throughputMeasurement": {
        "value": 10000
      },
      "localThroughputMeasurement": [
        {
          "writeOperationsPerSecond": 1000,
          "readOperationsPerSecond": 1000
        }
      ],
      "modules": [
        {
          "parameters": {}
        }
      ],
      "quantity": 1,
      "respVersion": "resp3",
      "redisVersion": "7.2",
      "queryPerformanceFactor": "2x"
    }
  ],
  "redisVersion": "7.2"
}

Response

Accepted

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

Changes