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.

How to archive incidents

There are a few ways to archive incidents:

From the UI

Archiving an incident from the Command Center
Archiving an incident from the Command Center
  1. Navigate to the incident you wish to archive.
  2. Click the gear icon next to the incident name.
  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'

Archiving all incidents

Here's an example script in bash that can automate this task. It first fetches all incidents and creates a list of all their UUIDs. Then it iterates through that list and archives each incident.

Prerequisites:

  • Need jq installed

There is a small sleep command to deliberately rate-limit requests to avoid hitting FireHydrant's API rate limiting. Remember to replace YOUR_BOT_TOKEN_HERE with your FireHydrant API key.

Note: Executing this script will archive all of your incidents without any confirmation or prompt. Please make sure you really want to run this before executing it.

#!/bin/bash

BOT_TOKEN="YOUR_BOT_TOKEN_HERE"

incident_ids=( $(curl --request GET --url https://api.firehydrant.io/v1/incidents --header "Authorization: ${BOT_TOKEN}" --header 'Content-Type: application/json' | jq -r '.data | .[] | .id') )

for id in "${incident_ids[@]}"; do
echo "Archiving incident with ID $id"
curl --request DELETE \
--url https://api.firehydrant.io/v1/incidents/"$id" \
--header "Authorization: ${BOT_TOKEN}" \
--header 'Content-Type: application/json'
echo "...done"
sleep 0.2
done

If you are not comfortable running the above script yourself, the FireHydrant support and success team can help. Log a support ticket to have our team archive ALL incidents from your account.

Note: When archiving all incidents, the incident ID numbers do not reset to zero; they continue to increment.

Unarchiving Incidents

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

Via UI

Viewing and unarchiving archived incidents
Viewing and unarchiving archived incidents
  1. In the UI, go to the Incidents page.
  2. Adjust the filters so you see only Archived incidents.
  3. Next to the incident(s) you want to unarchive, click the crossed out trashcan icon.

Note: This is only available via our new, refreshed user interface and not the previous one.

Via API

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

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

Last updated on 9/29/2023