Docs Menu
Docs Home
/
Atlas
/
Backup, Restore, and Archive
/
Restore Sources

Restore from a Locally-Downloaded Snapshot

On this page

  • Download Considerations
  • Restore Considerations
  • Required Access
  • Procedure

Atlas provides a mechanism for downloading dedicated cluster and shared cluster snapshots as compressed files.

Atlas deletes all existing data on the target cluster prior to the restore. The target cluster is available for the duration of the restore.

Download Considerations

If your manual download of a backup snapshot fails, Atlas keeps the request alive and allows you to restart the backup as long as the most recent download failure occurred no more than one hour ago.

For Atlas clusters deployed on AWS or Azure, if you configured any private endpoints, Atlas allows you to download the snapshot over the private endpoints in the same region as the snapshot. You might incur charges for downloading the snapshot over the private endpoint. To learn more, see Private Endpoints.

You can download encrypted snapshots in the same way as unencrypted snapshots. We recommend using role-based access to your encryption key for the project as a security best practice.

Restore Considerations

In addition to the prerequisites, consider the following requirements and limitations when restoring from a locally-downloaded snapshot.

  • If the DefaultRWConcern value on the source snapshot differs from the DefaultRWConcern value on the target cluster, Atlas overrides the value on the source snapshot with the value on the target cluster. If there is no value configured for the DefaultRWConcern on the target cluster, Atlas keeps the value of DefaultRWConcern from the snapshot without explicit configuration. This may differ from the default value for that MongoDB version.

  • This feature is unavailable for M0 clusters.

  • The downloaded files consist of the raw files copied from the data directory. mongorestore is incompatible with these files. To access the data files, use the following procedure to start a mongod instance and point it to the extract directory.

  • If you are at or near your cloud provider's Private Endpoint, you might not be able to download a snapshot through a private endpoint. In this case, use the public download endpoint that Atlas provides.

Required Access

To download a backup snapshot, you must have Project Backup Manager or Project Owner access to the project.

Procedure

1

In Atlas, go to the Clusters page for your project.

Warning

Navigation Improvements In Progress

We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.

  1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. If it's not already displayed, click Clusters in the sidebar.

    The Clusters page displays.

2

Go to the Backup page for your cluster.

  1. Click your cluster's name.

  2. Click the Backup tab.

    If the cluster has no Backup tab, then Atlas backups are disabled for that cluster and no snapshots are available. You can enable backups when you scale the cluster.

    The Backup page displays.

3

Request your snapshot.

  1. Click the Snapshots sub-tab.

  2. In the Actions column, expand the Actions menu, and click Download for the snapshot that you want to download.

    Atlas generates a one-time use download link that expires within 1 hour after its creation. For AWS or Azure, Atlas also generates a one-time-use download link for any configured private endpoints in the same region as the snapshot.

    The amount of time to create this link increases with the size of the Atlas cluster.

Once the download is ready, Atlas:

  • Emails you an alert that your snapshot download is ready.

  • Displays the download link in the Restores & Downloads tab.

Note

Available via API

As another option, you can request a restore snapshot using the API. The Atlas Administration API returns the download link in the deliveryUrl field for downloading over the public internet and in the privateDownloadDeliveryUrls field for downloading over the private endpoint in the same region as the snapshot.

4

Add the IP or CIDR address of the client to your Atlas project IP access list.

If the current project IP access list ranges do not cover the target client IP or CIDR address, click Add or Modify your IP Addresses to make changes to your Atlas project IP access list.

5

In Atlas, go to the Clusters page for your project.

Warning

Navigation Improvements In Progress

We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.

  1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. If it's not already displayed, click Clusters in the sidebar.

    The Clusters page displays.

6

Go to the Backup page for your cluster.

  1. Click your cluster's name.

  2. Click the Backup tab.

    If the cluster has no Backup tab, then Atlas backups are disabled for that cluster and no snapshots are available. You can enable backups when you scale the cluster.

    The Backup page displays.

7

Retrieve your snapshot.

  1. Click the Restores & Downloads sub-tab.

  2. Navigate to the restore snapshot you created.

  3. Click Download.

8

Use your preferred archive utility to extract the archive and access the data files.

Atlas compresses the snapshot into a .tar.gz file. This archive includes the snapshot and the mongod logs.

  1. Extract the files in the archive.

    Example

    The following command uses the tar utility to extract a tar``archive with ``gzip compression.

    tar -xvzf ~/Downloads/mongodb-snapshots/my-cluster-snapshot.tar.gz

  2. Access the data files by starting a mongod instance on the host and pointing it at the extract directory using the --dbpath option. To learn more, see Start mongod Processes.

    Example

    The following command starts a mongod instance using the extracted data file directory:

    mongod --dbpath ~/Downloads/mongodb-snapshots/my-cluster-snapshot/

Back

Restore from Another Project

Next

Restore from Cloud Manager Snapshot