MongoDB Database Backup/Restore Add-On

The Database Backup/Restore Add-On is compatible with standalone MongoDB databases and clustered MongoDB replica sets. It works together with dedicated Backup Storage to create scheduled or immediate database backups and restore selected snapshots when required.

In this article

Create Backup Storage
Install the add-on
Manage backups
Restore MongoDB
Expected result

Create Backup Storage

Before installing the backup add-on, create a dedicated storage instance to keep backup data. If Backup Storage already exists, skip directly to the add-on installation step.

Open Marketplace and install the dedicated Backup Storage package.

Backup Storage in Marketplace — Create the dedicated Backup Storage package from Marketplace.

In the installation window, choose between Standalone and Cluster storage. For Cluster storage, also specify the number of nodes. Then configure the storage size and standard environment details:

Environment — environment domain name
Display Name — environment alias
Region — environment region, if multiple regions are available

Backup Storage installation — Choose Standalone or Cluster storage and configure storage capacity and environment details.

Click Install and wait several minutes. The storage is automatically added to the Backup storage nodes group.

Backup Storage environment — The created storage is automatically added to the Backup storage nodes group.

Tip: One Backup Storage instance can be used by as many databases as needed.

Install the MongoDB Backup/Restore Add-On

Once the storage is ready, hover over the MongoDB database and click the Add-Ons icon. Locate Database Backup/Restore Add-On and click Install.

Configure the backup settings:

Pre-defined scheduleSelect a standard interval: hourly, daily, weekly, or monthly.

Custom scheduleChoose the exact Time, required Days of the week, and Time Zone.

Manual (crontab)Provide a cron-based expression using the UTC time zone.

Backup storageSelect one of the Backup Storage environments installed on the account.

Number of backupsSet how many of the newest backups should be retained for the current MongoDB database.

Database UserMongoDB user credentials used to access the database.

Database PasswordPassword for the selected MongoDB user.

Custom backup schedule — Set exact Time, Days of the week, and Time Zone for a custom schedule.

Crontab backup schedule — Provide a cron expression using UTC for manual scheduling.

MongoDB Backup Restore Add-On installation — Configure schedule, backup storage, retention count, and MongoDB credentials.

After about a minute, the platform displays an installation-success notification. The add-on starts working automatically according to the selected schedule.

MongoDB Backup Restore Add-On installed — The add-on starts working automatically after installation.

Managing the Add-On

Backup NowCreate an immediate MongoDB backup.

ConfigureChange the schedule, Backup Storage node, number of retained backups, or database credentials.

RestoreRestore the database from a selected backup.

UninstallRemove the backup add-on.

Managing MongoDB Backup Restore Add-On — Use Backup Now, Configure, Restore, or Uninstall.

During backup creation, the add-on uses the standard mongodump utility to create a database snapshot. The snapshot is stored on Backup Storage in a dedicated folder named according to the backed-up database, while each backup itself uses a distinct execution timestamp.

During restoration, the corresponding storage directory is mounted to the master node of the target database. The required snapshot is then restored using the standard mongorestore utility and applied to MongoDB.

Master node only: all backup and restore operations are performed on the database layer’s master node. For a non-clustered MongoDB database with multiple nodes, restored data is applied to one node only.

Restore MongoDB from Backup

Warning: restoring a database from backup overrides all existing data. Any changes made after the selected backup was created will be permanently lost.

Open the add-on and select Restore. In the dialog, choose:

Restore from — target environment. Multiple environments can appear if the add-on is used on several environments.
Backup — select the required backup for the chosen environment. Backup names include timestamps for quick identification.

Restore MongoDB from backup — Choose the source environment and timestamped backup to restore.

Click Restore and confirm the action in the pop-up. Once the operation starts, it cannot be canceled or reverted. The dashboard displays a success notification after restoration completes.

Expected Result

MongoDB backups are created automatically according to the configured schedule or manually with Backup Now. Snapshots are stored on dedicated remote Backup Storage using database-specific folders and execution timestamps, and selected backups can be restored through the add-on.

Important Notes

The add-on supports standalone MongoDB databases and clustered MongoDB replica sets.
Dedicated Backup Storage must exist before installing the add-on.
One Backup Storage instance can serve multiple databases.
Manual crontab scheduling uses UTC.
Backups are created with mongodump and restored with mongorestore.
Backup snapshots are organized by database name and execution timestamp.
Operations are performed on the database layer’s master node.
Restoration overrides existing data and cannot be canceled or reverted once started.