Backup & restore

The Backup & Restore module protects platform and customer data with scheduled MongoDB dumps, retention cleanup, and a restore workflow. Configuration is under Platform Settings → Backup Configuration.

How it works

A background job runs on BackupIntervalHours. Each cycle:

1. Runs mongodump against the database using MongoDumpExecutable.
2. Writes the archive into BackupFolder.
3. Prunes completed backups older than BackupRetentionDays.
4. Records the backup + prune in Audit.

Configuration

Backup Setting	Purpose
EnableBackup	Master switch for scheduled backups
BackupFolder	Where archives are written
BackupIntervalHours	Hours between backup runs
BackupRetentionDays	How long completed backups are kept
MongoDumpExecutable	Path to mongodump
MongoRestoreExecutable	Path to mongorestore

Note: Backup runs only when EnableBackup is on. Leave it off during initial setup until folders/executables are verified.

Restore workflow

Restore is an Operations action executed from the dashboard:

1. Select a backup archive in BackupFolder.
2. Platform runs mongorestore using MongoRestoreExecutable.
3. Restore is audited and, on completion, the affected entities are re-verified.

Retention

• Completed backups older than BackupRetentionDays are automatically removed.
• In-progress backups are never pruned mid-write.

Related

• Platform settings reference — Backup Configuration
• Architecture — Backup & Restore module
• Notifications — operational alerts on backup results