Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas backups restores start

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options

Start a restore job for your project and cluster.

mongocli atlas backups restores start <automated|download|pointInTime> [options]
Name
Type
Required
Description
deliveryType
string
false
Type of restore job to create. Accepted values include: automated, download, pointInTime.
Name
Type
Required
Description
--clusterName
string
false
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: json|json-path|go-template|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 last 24 hours of the current time.
--projectId
string
false
Project ID to use. Overrides configuration file or environment variable settings.
--snapshotId
string
false
Unique identifier of the snapshot to restore.
--targetClusterName
string
false
Name of the target cluster. For use only with automated restore jobs.
--targetProjectId
string
false
Unique identifier of the project that contains the destination cluster for the restore job.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.
←  mongocli atlas backups restores listmongocli atlas backups snapshots →
Share Feedback