Update default REST API docs path; Note on stdout api tokens (#1306)

This commit is contained in:
Jamil
2023-01-13 15:23:21 -08:00
committed by GitHub
parent 330cafbbe5
commit ec321c5619
7 changed files with 17 additions and 4 deletions

View File

@@ -49,7 +49,7 @@ issue](https://github.com/firezone/firezone/issues/new/choose).
## Upgrading to 0.7.x
Firezone 0.7.0 introduces a new [REST API](/reference/api/) that allows administrators
Firezone 0.7.0 introduces a new [REST API](/reference/rest-api/) that allows administrators
to automate much of the day to day configuration of Firezone.
The REST API `/v0/configuration` endpoint supersedes some of the previous environment

View File

@@ -9,9 +9,22 @@ Welcome to Firezone REST API v0 documentation.
To get started with the REST API, you'll first need an API token.
This can be generated in the UI at `/settings/account` or via the CLI
with `docker compose -f $HOME/.firezone/docker-compose.yml exec firezone bin/create-api-token`
on your live Firezone instance.
with:
```shell
docker compose -f $HOME/.firezone/docker-compose.yml exec firezone bin/create-api-token
```
**Note**: The token is written to `STDOUT` by default. You may wish to redirect its output
to a file instead:
```shell
docker compose -f $HOME/.firezone/docker-compose.yml exec firezone bin/create-api-token > fz_token
```
:::caution
API tokens generated from the CLI are owned by the primary administrator.
:::
```mdx-code-block
import DocCardList from '@theme/DocCardList';