REST API

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:

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:

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 DEFAULT_ADMIN_EMAIL environment variable.

This endpoint allows an administrator to manage Users.

This endpoint allows an administrator to manage Configurations.

This endpoint allows an administrator to manage Devices.

This endpoint allows an adminisrator to manage Rules.