API Keys

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 permissions.

Prerequisites

• You will need the Manage API Keys permission to create, modify, and remove API keys (or Read API Keys to view them). The built-in Owner role includes both, and these permissions can also be granted to a custom role.

Creating the API key

1. Go to Settings > 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 to the API keys page, where your token is displayed.

🚧

Note:

This token will only be displayed once.

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

Next Steps

• Learn about some of our other configurations and settings like Role-Based Access Controls
• See how you can store Secrets and use them with the Send a Webhook Runbook step
• Check out Command Extensions, which are custom chatbot commands you can create to make requests to external systems manually during incidents