Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas serverless watch

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Monitor the status of serverless instance.

This command checks the serverless instance's state periodically until the instance reaches an IDLE state. Once the instance reaches the expected state, the command prints "Instance available." If you run the command in the terminal, it blocks the terminal session until the resource becomes 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 that has the Project Owner role.

Command Syntax
mongocli atlas serverless watch <instanceName> [options]
Name
Type
Required
Description
instanceName
string
true
Name of the instance 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
mongocli atlas serverless watch instanceNameSample
←  mongocli atlas serverless listmongocli auth →
Share Feedback