Skip to content

Commit 2236f17

Browse files
committed
Change JSON body to the most basic example
1 parent df654ec commit 2236f17

File tree

1 file changed

+19
-28
lines changed

1 file changed

+19
-28
lines changed

content/operate/rc/api/examples/manage-subscriptions.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -96,26 +96,27 @@ Use [`POST /v1/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Sub
9696
```sh
9797
POST "https://[host]/v1/subscriptions"
9898
{
99-
"name": "Basic subscription example",
99+
"name": "Basic Subscription Example",
100100
"paymentMethodId": <payment_id>,
101101
"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+
}
113113
],
114114
"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+
}
119120
]
120121
}
121122
```
@@ -128,19 +129,9 @@ Modify the following parameters in the sample JSON document to create a subscrip
128129

129130
You don't need to pass this field in your API request if you subscribed to Redis Cloud through a marketplace integration.
130131

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

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" >}}).
144135

145136
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.
146137

0 commit comments

Comments
 (0)