Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas clusters onlineArchives watch

On this page

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

Watch for an archive to be available.

This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. Once the archive reaches the expected status, the command prints "Online archive available." If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. 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.

Command Syntax
atlas clusters onlineArchives watch <archiveId> [options]
Name
Type
Required
Description
archiveId
string
true
Unique identifier of the online archive to watch.
Name
Type
Required
Description
--clusterName
string
false
Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api.
-h, --help
false
help for watch
--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.

Online archive available.
atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample
← update
pause →