Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas clusters watch

On this page

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

Watch the specified cluster in your project until it becomes available.

This command checks the cluster's status periodically until it reaches an IDLE state. Once the cluster reaches the expected state, the command prints "Cluster available." If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. 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 watch <clusterName> [options]
Name
Type
Required
Description
clusterName
string
true
Name of the cluster to watch.
Name
Type
Required
Description
-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.

Cluster available.
# Watch for the cluster named myCluster to become available for the project with ID 5e2211c17a3e5a48f5497de3:
atlas clusters watch myCluster --projectId 5e2211c17a3e5a48f5497de3
← upgrade