Skip to content

Commit 6a828c2

Browse files
authored
Merge pull request #1009 from redis/DOC-4681
CAPI: Small changes to get started section
2 parents 344f6da + e35c72c commit 6a828c2

File tree

8 files changed

+24
-46
lines changed

8 files changed

+24
-46
lines changed

content/operate/rc/api/get-started/_index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To use the keys to authenticate and authorize your request, include the keys wit
2828

2929
## Enable the API
3030

31-
The API is disabled on all accounts by default. You must [enable the API]({{< relref "/operate/rc/api/get-started/enable-the-api.md" >}}) before you can use it.
31+
The API is disabled on all accounts by default. You must [enable the API]({{< relref "/operate/rc/api/get-started/enable-the-api" >}}) before you can use it.
3232

3333
## Account key
3434

@@ -44,20 +44,20 @@ If you need to change or delete your account key, please [contact support](https
4444

4545
## User key
4646

47-
The user key is a personal key that belongs to a specific user having the **owner** role. User keys are assigned owners when they're created. Keys cannot be assigned to users that aren't owners. Keys can belong to only one owner; however, an owner may have multiple keys.
47+
The user key is a personal key that belongs to a specific user having the **Owner**, **Viewer**, or **Logs viewer** role. User keys are assigned to users when they're created. Keys can belong to only one user; however, a user may have multiple keys.
4848

49-
You can view keys or copy their values _only_ during the [creation process]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}}).
49+
You can view keys or copy their values _only_ during the [creation process]({{< relref "/operate/rc/api/get-started/manage-api-keys" >}}).
5050

5151
{{< note >}}
5252
User keys are personal secrets. Do not share them.
5353
{{< /note >}}
5454

55-
Individual owners can [generate multiple user keys]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}})
55+
Individual owners can [generate multiple user keys]({{< relref "/operate/rc/api/get-started/manage-api-keys" >}})
5656
for themselves, for separate apps, or for other owners, viewers, or log viewers within the same account.
5757

5858
Use key names to uniquely associate specific API requests to individual users or apps.
5959

60-
Doing so lets you [audit API requests]({{< relref "/operate/rc/api/examples/audit-system-logs.md" >}}) using the system log, which tracks the key used to authenticate each request.
60+
Doing so lets you [audit API requests]({{< relref "/operate/rc/api/examples/audit-system-logs" >}}) using the system log, which tracks the key used to authenticate each request.
6161

6262
## Authentication using API keys
6363

@@ -79,5 +79,6 @@ An API request successfully authenticates when:
7979

8080
To learn more, see:
8181

82-
- [Manage API keys]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}})
83-
- [Use the API]({{< relref "/operate/rc/api/get-started/use-rest-api.md" >}})
82+
- [Manage API keys]({{< relref "/operate/rc/api/get-started/manage-api-keys" >}})
83+
- [Use the API]({{< relref "/operate/rc/api/get-started/use-rest-api" >}})
84+
- [Full API reference]({{< relref "/operate/rc/api/api-reference" >}})

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

Lines changed: 3 additions & 3 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

@@ -29,7 +29,7 @@ To enable the API:
2929

3030
{{<image filename="images/rc/button-access-management-enable-api.png" alt="Use the **Enable API** button to enable the REST API for your account." >}}
3131

32-
To authenticate REST API calls, you need to combine the API account key with an [API user key]({{< relref "/operate/rc/api/get-started/manage-api-keys#api-user-keys" >}}) to make API calls.
32+
To authenticate REST API calls, you need to use both the API account key and an [API user key]({{< relref "/operate/rc/api/get-started/manage-api-keys#api-user-keys" >}}) to make API calls.
3333

3434
Only account owners can see the access key in the account settings and give API access to other users.
3535

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The key name:
6262
- Must be between 10 and 50 characters long
6363
- Can contain alphanumeric characters, hyphens, and underscores. Spaces are not allowed.
6464

65-
The user name must have an owner, viewer, or logs viewer role.
65+
The selected user must have an owner, viewer, or logs viewer role.
6666

6767
Select **Create** to create the new key.
6868

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

static/images/rc/access-management-api-keys-tab.png

100755100644
-47.6 KB
Loading

static/images/rc/access-management-create-user-key.png

100755100644
-38 KB
Loading

static/images/rc/access-management-user-key-add.png

100755100644
-23.2 KB
Loading

0 commit comments

Comments
 (0)