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/create-database.md
+38-5Lines changed: 38 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,48 @@ You can use the Redis Cloud REST API to create and manage databases.
14
14
15
15
## Redis Cloud Essentials
16
16
17
-
To create a Redis Cloud Essentials database, use
17
+
### Create an Essentials database
18
+
19
+
To create a Redis Cloud Essentials database, use [`POST /fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}).
20
+
21
+
This call creates a database in the specified subscription. Use [`GET /fixed/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllSubscriptions_1" >}}) to get a list of Essentials subscriptions and their IDs.
22
+
23
+
```shell
24
+
POST "https://[host]/v1/fixed/subscriptions/{subscriptionId}/databases"
25
+
{
26
+
"name": "Basic-essentials-database-example"
27
+
}
28
+
```
29
+
30
+
This example JSON body contains only the most basic, required parameters in order to create a database:
31
+
32
+
-`name`: The database name. A unique name per subscription that can contain only alphanumeric characters and hyphens
33
+
34
+
There are other additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}).
35
+
36
+
Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports.
37
+
38
+
The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
39
+
40
+
### Update an Essentials database
41
+
42
+
To update a Redis Cloud Essentials database, use [`PUT /fixed/subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}).
43
+
44
+
The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/deleteFixedDatabaseByID" >}}).
45
+
46
+
Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports.
47
+
48
+
The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
18
49
19
50
## Redis Cloud Pro
20
51
21
-
### Create a Redis Cloud Pro database
52
+
### Create a Pro database
53
+
54
+
If you want to create a Pro database in a new subscription, see [Create a Pro subscription]({{< relref "/operate/rc/api/examples/manage-subscriptions#create-a-pro-subscription" >}}).
22
55
23
-
To create a Redis Cloud Pro database, use `POST /subscriptions/{subscriptionId}/databases`.
56
+
To create a Redis Cloud Pro database in an existing subscription, use [`POST /subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}).
24
57
25
-
This call creates a database in the specified subscription. Use `GET /subscriptions` to get a list of subscriptions and their IDs.
58
+
This call creates a database in the specified subscription. Use [`GET /subscriptions`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}) to get a list of subscriptions and their IDs.
26
59
27
60
```shell
28
61
POST "https://[host]/v1/subscriptions/{subscriptionId}/databases"
@@ -43,7 +76,7 @@ The response body contains the `taskId` for the task that creates the database.
43
76
44
77
### Update a Redis Cloud Pro database
45
78
46
-
To update a Redis Cloud Pro database, use `PUT /subscriptions/{subscriptionId}/databases/{databaseId}`.
79
+
To update a Redis Cloud Pro database, use [`PUT /subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}).
47
80
48
81
The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/updateDatabase" >}}).
Copy file name to clipboardExpand all lines: content/operate/rc/api/examples/manage-subscriptions.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ Modify the following parameters in the sample JSON document to create a subscrip
38
38
39
39
Use [`GET /v1/fixed/plans`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllFixedSubscriptionsPlans" >}}) to get a list of plan IDs.
40
40
41
-
After you create an Essentials subscription, you must use the [`POST /v1/fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}) endpoint to create the database.
41
+
After you create an Essentials subscription, you must use the [`POST /v1/fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}) endpoint to [create the database]({{< relref "/operate/rc/api/examples/create-database#redis-cloud-essentials" >}}).
42
42
43
43
You can include the contents of the JSON document in the `POST /v1/fixed/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.
0 commit comments