Skip to content

Commit fb21efb

Browse files
committed
Enable API, manage tasks, process lifecycle
1 parent 74c510c commit fb21efb

File tree

3 files changed

+14
-37
lines changed

3 files changed

+14
-37
lines changed

content/operate/rc/api/get-started/enable-the-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ description: Use the Redis Cloud dashboard to enable the REST API.
99
weight: 10
1010
---
1111

12-
If you have a Redis Cloud subscription, you can use a REST API to manage your subscription programmatically.
12+
If you have a Redis Cloud account, you can use a REST API to manage your subscriptions and databases programmatically.
1313

14-
For security reasons, the Redis Cloud API is disabled by default.
14+
For security reasons, the Redis Cloud API is inactive by default.
1515

1616
To enable the API:
1717

content/operate/rc/api/get-started/manage-tasks.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@ After you request an asynchronous operation, the operation returns a `taskId` th
2424

2525
Tasks are part of the API [processing and provisioning lifecycle]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}).
2626

27-
### Task information
27+
## Task information
2828

29-
When you query a task of an asynchronous API operation,
30-
the response to the request includes the task status and additional information about the task:
29+
When you request an asynchronous operation, the response to the request includes the task status and additional information about the task:
3130

3231
```json
3332
{
@@ -57,19 +56,15 @@ Where:
5756
- A link to itself
5857
- Additional links based on the context of the response
5958

60-
### Task status updates
59+
## Task status updates
6160

6261
With the task ID, you can query the task status for updates and progress information.
6362
The response in the above example shows a URL with the title `getTaskStatusUpdates`.
6463
The URL in the `href` property returns updates for the specified task.
6564

66-
This request returns the updated status of the task identifier:
65+
Use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to check the task status.
6766

68-
```bash
69-
GET "https://[host]/v1/tasks/<taskId>"
70-
```
71-
72-
The response to the `getTaskStatusUpdates` request shows:
67+
This endpoint returns information about the queried task.
7368

7469
```json
7570
{
@@ -104,12 +99,8 @@ This response example shows:
10499

105100
### Tasks list
106101

107-
You can use the API operation `GET /tasks` to list the recently submitted and completed tasks for the current account.
102+
You can use the API operation [`GET /tasks`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getAllTasks" >}}) to list the recently submitted and completed tasks for the current account.
108103

109104
This API operation returns a list of tasks for the current account, sorted by most recent status update.
110105

111-
```bash
112-
GET "https://$HOST/tasks"
113-
```
114-
115106
The result returns all the tasks submitted during the past 10 days.

content/operate/rc/api/get-started/process-lifecycle.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ description: API requests follow specific lifecycle phases and states, based on
1010
linkTitle: API request lifecycle
1111
weight: 60
1212
---
13-
All Redis Cloud [subscriptions]({{< relref "/operate/rc/subscriptions/" >}}) can leverage a RESTful API that permits operations against a variety of resources, including servers, services, and related infrastructure.
13+
Redis Cloud owners and viewers can leverage a RESTful API that permits operations against a variety of resources, including subscriptions, databases, and related infrastructure.
1414

1515
[Once it's enabled]({{< relref "/operate/rc/api/get-started/enable-the-api.md" >}}), you can use the REST API to create, update, and delete subscriptions, databases, and other entities.
1616

17-
API operations run asynchronously, which means that provisioning occurs in the background. When you submit a request, a background process starts working on it. The response object includes an ID that lets you determine the status of the background process as it performs its work.
17+
All create, update, and delete API operations (`POST`, `PUT`, and `DELETE`) and some query operations (`GET`) run asynchronously, which means that provisioning occurs in the background. When you submit a request, a background process, known as a **Task**, starts working on it. The response object includes an ID that lets you determine the status of the background process as it performs its work.
1818

19-
For operations that do not create or modify resources (such as most GET operations), the API is sychronous; that is, the response object reports the results of the request.
19+
For operations that do not create or modify resources (such as most GET operations), the API is synchronous; that is, the response object reports the results of the request.
2020

2121
Asynchronous operations have two main phases: processing and provisioning. A resource is not available until both phases are complete.
2222

@@ -30,17 +30,9 @@ During this phase, the request is received, evaluated, planned, and executed.
3030

3131
Many operations are asychronous, including CREATE, UPDATE, and DELETE operations. The response objects for such operations provide a `taskId` identifier that lets you track the progress of the underlying operation.
3232

33-
You can query the `taskId` to track the state of a specific task:
33+
You can query the `taskId` to track the state of a specific task using [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}).
3434

35-
```shell
36-
GET "https://[host]/v1/tasks/<taskId>"
37-
```
38-
39-
You can also query the state of all active tasks or recently completed tasks in your account:
40-
41-
```shell
42-
GET "https://[host]/v1/tasks"
43-
```
35+
You can also query the state of all active tasks or recently completed tasks in your account using [`GET /tasks`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getAllTasks" >}})
4436

4537
### Task process states
4638

@@ -69,13 +61,7 @@ The term "provisioning" refers to all infrastructure changes required in order t
6961

7062
The provisioning phase may require several minutes to complete. You can query the resource identifier to track the progress of the provisioning phase.
7163

72-
For example, when you provision a new subscription, use this API call to query the status of the subscription:
73-
74-
```shell
75-
GET "https://[host]/v1/subscriptions/<subscription-id>"
76-
```
77-
78-
Where the `<subscription-id>` is the resource ID that you receive when the task is in the `processing-completed` state.
64+
For example, when you provision a new subscription, use [`GET /v1/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/getSubscriptionById" >}}), where the `{subscriptionId}` is the resource ID that you receive when the task is in the `processing-completed` state.
7965

8066
### Provisioning state values
8167

0 commit comments

Comments
 (0)