Documentation
Contact Support

Archiving Incidents

FireHydrant allows you to archive incidents so they’re hidden from the UI and not counted in your analytics. You may want to archive incidents because:

  • You’ve been testing the FireHydrant platform, and you may want to clear all incidents for a “fresh start” in your account
  • You accidentally created an incident, and you want to remove it so it’s not counted in your analytics

When you archive an incident, it is hidden from the FireHydrant UI and also from the Analytics data and API.

📘

Note:

Archiving an incident will immediately halt any attached Runbooks and executing Runbook steps, as well as exclude the incident data from any Analytics and Metrics calculations. It will also hide the incident by default on the Incidents page.

Permissions

By default, users with the manage_incidents permission can archive incidents. Organizations can restrict this capability further through role-based access control to ensure only specific roles (such as Incident Owners or Incident Commanders) can archive incidents. This helps preserve data integrity and prevents accidental archiving of important incidents.

To restrict who can archive incidents:

  1. Navigate to Settings > Roles
  2. Configure which roles should have the ability to archive incidents
  3. Ensure that responders who should not archive incidents are not assigned those roles, or have their permissions adjusted accordingly

Consult your organization's role-based access control settings for more details on configuring archiving permissions.

Archiving incidents

From the Command Center

Archiving an incident from its Command Center

Archiving an incident from its Command Center

  1. Navigate to the incident you wish to archive.
  2. Click the Ellipses next to the "Resolve incident" button.
  3. Select Archive incident.

With the API

You can archive incidents using our Archive an Incident API endpoint. Here is an example API call using cURL:

curl --request DELETE \
  --url https://api.firehydrant.io/v1/incidents/${YOUR_INCIDENT_ID} \
  --header 'Authorization: ${YOUR_AUTH_TOKEN}' \
  --header 'Content-Type: application/json'

Unarchiving Incidents

If you decide that you want to retrieve any previously-archived incidents, there are two ways you can do so.

Via UI

Showing the unarchive button next to Archived incidents

Showing the unarchive button next to Archived incidents

  1. In the web UI, go to the Incidents page at the top navigation
  2. Adjust the filters so you see only Archived incidents.
  3. Next to the incident(s) you want to unarchive, click the crossed-out trashbin.

Via API

You can use the Unarchive Incident API endpoint. Here is an example API call usingcURL:

curl --request POST \
  --url https://api.firehydrant.io/v1/incidents/${YOUR_INCIDENT_ID}/unarchive \
  --header 'Authorization: ${YOUR_AUTH_TOKEN}' \
  --header 'Content-Type: application/json'

Other Recipes and Scripts

Visit the Recipes section of the documentation website for various example recipes. For example:

Next Steps

Updated 13 days ago