Backup and Restore

Export and restore your Exaviz board configuration

Creating a Backup

Export your board’s full configuration as a .tar.gz archive:

  1. Open the dashboard settings
  2. Click Download Backup

Or via the API:

curl -k -H "Authorization: Bearer <token>" \
  -o backup.tar.gz \
  https://<board-ip>/api/v1/system/backup

What’s Included

The backup contains everything in the board’s data directory (/var/lib/exaviz/):

DataDescription
Port labelsCustom names assigned to PoE ports
Port groupsGroup definitions and port membership
Alert configurationThreshold settings and alert history
Audit logComplete history of all actions taken on the board
User preferencesTheme selection, view mode, fleet board order
Fleet trust stateEd25519 key pair and list of trusted peers
TLS certificatesCurrent certificates and private keys
OEM brandingBranding configuration (if customized)

Restoring from a Backup

Upload a backup archive to restore a board’s configuration:

  1. Open the dashboard settings
  2. Click Restore from Backup
  3. Select the backup .tar.gz file
  4. Confirm the restore

Or via the API:

curl -k -X POST -H "Authorization: Bearer <token>" \
  -F "backup=@backup.tar.gz" \
  https://<board-ip>/api/v1/system/restore

Use Cases

Cloning Configuration Across a Fleet

  1. Configure one board completely (labels, groups, branding, TLS, alerts)
  2. Export a backup
  3. Restore the backup to each additional board in the fleet

This gives you consistent configuration across all boards without manual setup on each device.

Disaster Recovery

Regularly export backups to protect against SD card failure or accidental misconfiguration. Store backups off-board (on your workstation, NAS, or cloud storage).

Pre-Deployment Imaging

Include the backup contents in your custom OS image so new boards boot with your configuration already in place. Combined with OEM branding, this enables true zero-touch deployment.

Last modified April 9, 2026