Backup & Restore
RhythmX supports on-demand backups from the UI. Admins can create full or config-only backups before upgrades, download them off-server, and view backup history.
Backup Types
| Type | What It Covers | Use Case |
|---|---|---|
| Full Backup | Platform configuration + essential database data (incidents, cases, users, detection rules, audit trail) | Before upgrades, disaster recovery |
| Config Only | Platform configuration files only (no database) | Quick snapshot of current settings |
Info
Full backups are optimized to include only essential data that cannot be recreated automatically. Large operational tables that rebuild from live sources are excluded to keep backup sizes manageable.
Creating a Backup
- Navigate to System Settings > Integrations
- Expand the Backup & Restore section
- Click Full Backup or Config Only
A progress indicator is shown while a full backup is in progress — this may take several minutes depending on database size. Config-only backups complete in seconds.
After creation, the backup appears in the history table.
Backup History
The history table shows all backups stored on the server.
| Column | Description |
|---|---|
| Filename | Archive name with timestamp |
| Type | Full or Config |
| Size | Compressed archive size |
| Created | Timestamp of creation |
| By | Admin who created the backup |
| Actions | Download or Delete |
Click Refresh to reload the backup list.
Downloading a Backup
Click the download icon next to any backup in the history table. The archive is streamed directly to your browser.
Best Practice
Always download backups to an off-server location before performing upgrades. Backups stored only on the RhythmX server are lost if the server is rebuilt.
Deleting a Backup
Click the delete icon next to any backup. A confirmation dialog is shown before deletion. This action cannot be undone.
Restoring from Backup
Restore is performed from the command line by your system administrator. Detailed restore instructions are shown at the bottom of the Backup & Restore section in the UI.
Warning
Restoring a full backup will overwrite existing incident workflow data, user accounts, detection rules, and configuration. Coordinate with your team before restoring.
Notes
- All backup operations require admin or superadmin role
- Every backup includes a SHA-256 checksum file for integrity verification
- Backup creation checks for sufficient disk space before starting
- All backup actions are recorded in the Audit Log