Create and manage subscriptions

You can use the Redis Enterprise Cloud REST API to create and manage a subscription.

Create a subscription

The API operation that creates a subscription is POST /v1/subscriptions.

POST "https://[host]/v1/subscriptions"
{
    "name": "Basic subscription example",
    "paymentMethodId": <payment_id>,
    "cloudProviders": [
      {
        "cloudAccountId": <account_id>,
        "regions": [
          {
            "region": "us-east-1",
            "networking": {
              "deploymentCIDR": "10.0.0.0/24"
            }
          }
        ]
      }
    ],
    "databases": [
      {
        "name": "Redis-database-example",
        "memoryLimitInGb": 1.1
      }
    ]
}

To use the sample JSON document in your own account, you must modify these parameters:

• paymentMethodId - Specify a payment method that is defined for your account.

  You can lookup the payment method identifier using the GET /payment-methods API operation.

  If you subscribed to Redis Enterprise Cloud through the GCP Marketplace, you do not need to pass this field in your API requests.

• cloudAccountId - Specify a cloud account that is defined for your account.

  You can look up cloud account identifiers using the GET /cloud-accounts API operation or use "cloudAccountId": 1 to use internal resources.

  If you subscribed to Redis Enterprise Cloud through the GCP Marketplace, use the value 1 for this field.

• The JSON document contains two primary segments: subscription specification and databases specification.

• When you create a subscription, you must specify one or more databases in the “databases” array of the above JSON file.

• You can copy-and-paste the contents of the JSON file into the POST /subscriptions operation in the Swagger UI.

The POST response is a JSON document that contains the taskId. You can use GET /v1/tasks/<taskId> to track the creation of your subscription.