Skip to main content

API Keys

In order to access the FireGuard API, you have to create and manage your API keys. These keys allow members within your organization to access the FireGuard API. You can manage you API keys by heading to the Organization Settings page in the tab Organization.

Remember that an API key is linked to an organization, not to a user.

warning

API keys are meant to be kept secret. Do not share your API keys with anyone who should not have access to your FireGuard organization.

Create a key​

Once in the API Keys section of the Organization Settings page in the tab Organization, you can create a new key by clicking the Add API Key button. You will then be asked to give the key a name. The name is simply there to help you find your keys. Once the name is entered, you can click on Create API Key.

Your newly created API Key is displayed right away. You can use the copy button to copy the key to your clipboard.

Deleting a key​

A key can be deleted using the deletion button from the list of API keys.

List of API keys
warning

Be cautious when deleting an API key since the action cannot be undone

Using a key​

Any request made to the FireGuard API needs to provide the X-Api-Key header which includes the API key used for the request.