Docs Menu

Docs HomeLaunch & Manage MongoDBAtlas CLI

atlas backups restores watch

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Watch for a restore job to complete.

This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. Once the restore reaches the expected status, the command prints "Restore completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. You can interrupt the command's polling at any time with CTRL-C.

Command Syntax
atlas backups restores watch <restoreJobId> [options]
Name
Type
Required
Description
restoreJobId
string
true
ID of the restore job.
Name
Type
Required
Description
--clusterName
string
true
Name of the cluster.
-h, --help
false
help for watch
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Restore completed.
# Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the restore source cluster named Cluster0 until it becomes available:
atlas backup restore watch 507f1f77bcf86cd799439011 --clusterName Cluster0
← atlas backups restores start