atlas serverless backups restores watch
On this page
Watch the specified backup restore job until it completes.
This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. Command finishes once one of the expected statuses are reached. 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. To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
Command Syntax
atlas serverless backups restores watch [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. |
-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. |
--restoreJobId | string | true | Unique identifier that identifies the Restore Job. |
Inherited Options
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Restore completed.
Examples
# Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0 until it becomes available: atlas serverless backup restore watch --restoreJobId 507f1f77bcf86cd799439011 --clusterName Cluster0