Navigation

mongocli atlas privateendpoint regionalmode describe

The privateendpoint regionalmode describe command retrieves whether the regionalized private endpoint setting is enabled or disabled for an Atlas project. If enabled, this setting lets you use regionalized private endpoints for multi-region sharded clusters. You can also retrieve the regionalized private endpoint setting through the Atlas UI or API.

mongocli atlas privateEndpoint(s)|private-endpoint(s)|privateendpoint(s) regionalMode(s)|regional-mode(s)|regionalmode(s) describe|get
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
[ --projectId <project-ID> ]
Note

Use -h or --help to view the command-line help for this command.

Option
Type
Description
Required?
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using the Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string
Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no

If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.

ENABLED
<true or false>

The following command retrieves the regionalized private endpoint setting (disabled) in a project using the default profile, which contains credentials for accessing the project and the project ID. The output is returned in the default format.

mongocli atlas privateendpoint regionalmode describe

The previous command prints the following to the terminal.

ENABLED
false
Give Feedback