Get started with the REST API

Follow these steps to enable Firezone's REST API and generate the credentials you need to authenticate your requests. For details on the available endpoints, see the REST API reference.

Request API access

Open the Settings -> API Clients section of the admin portal and request access. This sends a notification to the Firezone team to enable the API for your account.

Create an API client and token

Once the API is enabled for your account:

1. Generate an API Client from the same page where you requested access.
2. Generate an API Token for that client.
3. Use the token to authenticate your requests.

Need help? See all support options.