mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
643330fcbe
- [x] Move all docs to be served under `/docs` prefix - [x] Merge blog articles and serve under `/blog` prefix - [x] Remove docs side bar for blog content - [x] Remake marketing site pages in markdown/react - [x] Serve marketing site under root path - [x] Update all old links and paths to use new prefixes
---
title: REST API
sidebar_position: 10
---
Welcome to Firezone's REST API v0 documentation.
## Getting started
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:
```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 specified by
the `ADMIN_EMAIL` environment variable.
:::
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```