You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rc/api/examples/manage-subscriptions.md
+19-28Lines changed: 19 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -96,26 +96,27 @@ Use [`POST /v1/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Sub
96
96
```sh
97
97
POST "https://[host]/v1/subscriptions"
98
98
{
99
-
"name": "Basic subscription example",
99
+
"name": "Basic Subscription Example",
100
100
"paymentMethodId": <payment_id>,
101
101
"cloudProviders": [
102
-
{
103
-
"cloudAccountId": <account_id>,
104
-
"regions": [
105
-
{
106
-
"region": "us-east-1",
107
-
"networking": {
108
-
"deploymentCIDR": "10.0.0.0/24"
109
-
}
110
-
}
111
-
]
112
-
}
102
+
{
103
+
"provider": "AWS",
104
+
"regions": [
105
+
{
106
+
"region": "us-east-1",
107
+
"networking": {
108
+
"deploymentCIDR": "10.0.1.0/24"
109
+
}
110
+
}
111
+
]
112
+
}
113
113
],
114
114
"databases": [
115
-
{
116
-
"name": "Redis-database-example",
117
-
"memoryLimitInGb": 1.1
118
-
}
115
+
{
116
+
"name": "Redis-database-example",
117
+
"protocol": "redis",
118
+
"datasetSizeInGb": 1
119
+
}
119
120
]
120
121
}
121
122
```
@@ -128,19 +129,9 @@ Modify the following parameters in the sample JSON document to create a subscrip
128
129
129
130
You don't need to pass this field in your API request if you subscribed to Redis Cloud through a marketplace integration.
130
131
131
-
-**`cloudAccountId`** - Set a cloud account ID connected to your account.
132
+
The request JSON body 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.
132
133
133
-
To list cloud account IDs, use [`GET /v1/cloud-accounts`]({{< relref "/operate/rc/api/api-reference#tag/Cloud-Accounts/operation/getCloudAccounts" >}}).
134
-
135
-
You don't need to pass this field in your API request if you want to use internal resources.
136
-
137
-
The request JSON body 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.
138
-
139
-
You can include the contents of the JSON document in the `POST /subscriptions` operation in the [Swagger UI](https://api.redislabs.com/v1/swagger-ui.html). See [Swagger user interface]({{< relref "/operate/rc/api/get-started/use-rest-api#swagger-user-interface" >}}) for more details.
140
-
141
-
{{< note >}}
142
-
The Swagger UI generates default JSON examples for `POST` and `PUT` operations. You can reference these examples and modify them to fit your specific needs and account settings. The examples will fail if used as-is.
143
-
{{< /note >}}
134
+
There are many additional parameters and settings that can be defined on subscription and database creation. Review the subscription parameters and options in the [Full API documentation]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/createSubscription" >}}).
144
135
145
136
The response body contains the `taskId` for the task that creates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
0 commit comments