Skip to content

Commit 3b66b42

Browse files
committed
Update
1 parent ac61e7b commit 3b66b42

File tree

5 files changed

+11
-9
lines changed

5 files changed

+11
-9
lines changed

docs/dev/reference/apis/billing-client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You will also need an API key and API key ID to authenticate your session.
3333
Your API key needs to have [Org owner permissions](/manage/manage/rbac/#organization-settings-and-roles) to use the billing client API.
3434
To get an API key (and corresponding ID), you have two options:
3535

36-
- [Create an API key using the Viam app](/cloud/rbac/#add-an-api-key)
36+
- [Create an API key using the Viam app](/operate/control/api-keys/#add-an-api-key)
3737
- [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key)
3838

3939
The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates a `BillingClient`:

docs/dev/reference/apis/data-client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To use the Viam data client API, you first need to instantiate a [`ViamClient`](
4949
You will also need an API key and API key ID to authenticate your session.
5050
To get an API key (and corresponding ID), you have two options:
5151

52-
- [Create an API key using the Viam app](/cloud/rbac/#add-an-api-key)
52+
- [Create an API key using the Viam app](/operate/control/api-keys/#add-an-api-key)
5353
- [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key)
5454

5555
The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates a `DataClient`:

docs/operate/control/api-keys.md

+6
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,9 @@ See [Permissions](/manage/manage/rbac/) for information about the privilege each
3838
To change the entities it is able to access, click **+ Grant additional access**.
3939
Select which organization, location, or machine you want the key to grant access to.
4040
Click **Choose** to confirm your selection.
41+
42+
## Rotate an API key
43+
44+
If you ever need to rotate an API key, click on the **Generate Key** button on the organization setting page to generate a new key.
45+
46+
Viam supports flexible key rotation with up to two keys in use at one time. After generating a new secret key, update all references to the key in your code as soon as possible and then remove the old key.

static/include/app/apis/generated/app.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -803,11 +803,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
803803

804804
### GetRobotAPIKeys
805805

806-
<<<<<<< HEAD
807-
Gets the [API keys](/operate/control/api-key/) for the machine.
808-
=======
809806
Gets the [API keys](/operate/control/api-keys/) for the machine.
810-
>>>>>>> e7a4cb207 (Add API key page)
811807

812808
{{< tabs >}}
813809
{{% tab name="Python" %}}
@@ -2188,7 +2184,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
21882184

21892185
### DeleteKey
21902186

2191-
Delete an [API key](/operate/control/api-key/).
2187+
Delete an [API key](/operate/control/api-keys/).
21922188

21932189
{{< tabs >}}
21942190
{{% tab name="Python" %}}
@@ -2214,7 +2210,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
22142210

22152211
### RotateKey
22162212

2217-
Rotate an [API key](/manage/manage/access/#rotate-an-api-key).
2213+
Rotate an [API key](/operate/control/api-keys/#rotate-an-api-key).
22182214

22192215
{{< tabs >}}
22202216
{{% tab name="Python" %}}
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Rotate an [API key](/manage/manage/access/#rotate-an-api-key).
1+
Rotate an [API key](/operate/control/api-keys/#rotate-an-api-key).

0 commit comments

Comments
 (0)