Docs Menu

atlas backups restores start

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Start a restore job for your project and cluster.

atlas backups restores start <automated|download|pointInTime> [options]
Name
Type
Required
Description
deliveryType
string
true
Type of restore job to create. Accepted values include: automated, download, pointInTime.
Name
Type
Required
Description
--clusterName
string
true
Name of the cluster.
-h, --help
false
help for start
--oplogInc
int
false
32-bit incrementing ordinal that represents operations within a given second. When paired with oplogTs, they represent the point in time to which your data will be restored.
--oplogTs
int
false
Oplog timestamp given as a timestamp in the number of seconds that have elapsed since the UNIX Epoch. When paired with oplogInc, they represent the point in time to which your data will be restored.
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file.
--pointInTimeUTCMillis
int
false
Timestamp in the number of milliseconds that have elapsed since the UNIX epoch that represents the point in time to which your data will be restored. This timestamp must be within the last 24 hours of the current time.
--projectId
string
false
Project ID to use. Overrides the settings in the configuration file or environment variable.
--snapshotId
string
false
Unique identifier of the snapshot to restore. You must specify a snapshotId for automated restores.
--targetClusterName
string
false
Name of the target cluster. For use only with automated restore jobs. You must specify a targetClusterName for automated restores.
--targetProjectId
string
false
Unique identifier of the project that contains the destination cluster for the restore job. You must specify a targetProjectId for automated restores.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.
The following example creates an automated restore:
$ atlas backup restore start automated \
--clusterName myDemo \
--snapshotId 5e7e00128f8ce03996a47179 \
--targetClusterName myDemo2 \
--targetProjectId 1a2345b67c8e9a12f3456de7
The following example creates a point-in-time restore:
$ atlas backup restore start pointInTime \
--clusterName myDemo \
--pointInTimeUTCMillis 1588523147 \
--targetClusterName myDemo2 \
--targetProjectId 1a2345b67c8e9a12f3456de7
The following example creates a download restore:
$ atlas backup restore start download \
--clusterName myDemo \
--snapshotId 5e7e00128f8ce03996a47179
What is MongoDB Atlas? →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.