Creating an API key

FireHydrant allows you to access the API with an API key using token-based authentication. An API key can perform actions like any other user and by default, it will have Owner privileges.

Note: Only Organization Owners can create API keys.

Creating the API key

  1. Go to Settings > Integrations > API Keys.
  2. Click + Create API key. The next page provides fields for a name and description of the key; these fields are for your reference and do not impact how the API is used.
  3. Provide the name and description and click Save. You will be redirected back to the API keys page, where your token is displayed.
API Key Token
API Key Token

Note: This token will only be displayed once.

  1. Copy the API key and record it somewhere safe, as it grants access to the FireHydrant API on behalf of your organization.

Last updated on 2/9/2024