Roll back firmware through the REST API

1. In a browser, navigate to the REST API Explorer.
   The URL is the hostname or IP address of your sensor or console, followed by /api/v1/explore/. For example, if your hostname is seattle-eda, the URL is https://seattle-eda/api/v1/explore/.
2. Click Enter API Key and then paste or type your API key into the API Key field.
3. Click Authorize and then click Close.
4. View the previous version of firmware you can roll back to.
   1. Click ExtraHop and then click GET /extrahop​/firmware​/previous.
   2. Click Try it out.
   3. Click Send Request.
      The Server response section displays the following information:

      version: The previous firmware version that the system can be rolled back to.

      backup_time: The last time that the sensor or console generated a backup file before being upgraded to the current version, expressed in milliseconds since the epoch. The sensor or console automatically creates a backup each time the system is upgraded.

      The information appears in a format similar to the following text:

      {
        "version": "8.4.0.1522",
        "backup_time": 1617229294388
      }

      Copy

5. Roll back the firmware version.
   1. Click POST ​/extrahop​/firmware​/previous​/rollback.
   2. Click Try it out.
   3. Click Send Request.
      The Server response section displays a 202 status code.

      Note:

      The rollback process might take several minutes to complete.

6. Verify the firmware upgrade is complete.
   1. Click GET ​/extrahop.
   2. Click Try it out.
   3. Click Send Request.
      If the firmware rollback process is complete, the Server response section displays a 200 status code and the version of firmware the sensor or console is currently running.

      If the firmware rollback process is still in progress, the Server response section displays a 503 error code.

The ExtraHop GitHub repository contains an example Python script that rolls back firmware for multiple sensors or consoles by reading URLs and API keys from a CSV file.

1. Go to the ExtraHop code-examples GitHub repository and download the rollback_firmware/rollback_firmware.py file to your local machine.
2. Create a CSV file with rows that contain the following columns in the specified order:

   System hostname

   API key

   Tip:	The rollback_firmware directory contains an example CSV file named systems.csv.

3. In a text editor, open the upgrade_system.py file and replace the following configuration variables with information from your environment:

   SYSTEM_LIST: The relative file path of the CSV file.

4. Run the following command:

   python3 rollback_firmware.py

   Copy

   The script returns the version that each sensor or console can be rolled back to.

   Note:

   If the script returns an error message that the TLS certificate verification failed, make sure that a trusted certificate has been added to your sensor or console. Alternatively, you can add the verify=False option to bypass certificate verification. However, this method is not secure and is not recommended. The following code sends an HTTP GET request without certificate verification: requests.get(url, headers=headers, verify=False) Copy

5. To start the rollback process, type y and press ENTER.