Backup and Restore
2 minute read
Creating a Backup
Export your board’s full configuration as a .tar.gz archive:
- Open the dashboard settings
- 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/):
| Data | Description |
|---|---|
| Port labels | Custom names assigned to PoE ports |
| Port groups | Group definitions and port membership |
| Alert configuration | Threshold settings and alert history |
| Audit log | Complete history of all actions taken on the board |
| User preferences | Theme selection, view mode, fleet board order |
| Fleet trust state | Ed25519 key pair and list of trusted peers |
| TLS certificates | Current certificates and private keys |
| OEM branding | Branding configuration (if customized) |
Restoring from a Backup
Upload a backup archive to restore a board’s configuration:
- Open the dashboard settings
- Click Restore from Backup
- Select the backup
.tar.gzfile - 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
Restoring a backup replaces the board’s current configuration. The board may need to restart services to apply the restored settings.
Use Cases
Cloning Configuration Across a Fleet
- Configure one board completely (labels, groups, branding, TLS, alerts)
- Export a backup
- 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