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/get-started/_index.md
+8-7Lines changed: 8 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ To use the keys to authenticate and authorize your request, include the keys wit
28
28
29
29
## Enable the API
30
30
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.
32
32
33
33
## Account key
34
34
@@ -44,20 +44,20 @@ If you need to change or delete your account key, please [contact support](https
44
44
45
45
## User key
46
46
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.
48
48
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" >}}).
50
50
51
51
{{< note >}}
52
52
User keys are personal secrets. Do not share them.
53
53
{{< /note >}}
54
54
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" >}})
56
56
for themselves, for separate apps, or for other owners, viewers, or log viewers within the same account.
57
57
58
58
Use key names to uniquely associate specific API requests to individual users or apps.
59
59
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.
61
61
62
62
## Authentication using API keys
63
63
@@ -79,5 +79,6 @@ An API request successfully authenticates when:
79
79
80
80
To learn more, see:
81
81
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" >}})
Copy file name to clipboardExpand all lines: content/operate/rc/api/get-started/enable-the-api.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ To enable the API:
29
29
30
30
{{<imagefilename="images/rc/button-access-management-enable-api.png"alt="Use the **Enable API** button to enable the REST API for your account." >}}
31
31
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.
33
33
34
34
Only account owners can see the access key in the account settings and give API access to other users.
0 commit comments