Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas privateEndpoints gcp watch

On this page

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

Watch the specified GCP private endpoint to detect changes in the endpoint's state.

This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available 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 that has the Project Read Only role.

Command Syntax
mongocli atlas privateEndpoints gcp watch <privateEndpointId> [options]
Name
Type
Required
Description
privateEndpointId
string
true
Unique 22-character alphanumeric string that identifies the private endpoint.
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

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

GCP Private endpoint changes completed.
mongocli atlas privateEndpoint gcp watch vpce-abcdefg0123456789
←  mongocli atlas privateEndpoints gcp listmongocli atlas privateEndpoints onlineArchive →
Share Feedback