Navigation

mongocli atlas privateendpoint regionalmode enable

The privateendpoint regionalmode enable command enables the regionalized private endpoint setting for an Atlas project. This setting lets you use regionalized private endpoints for multi-region sharded clusters. You can also enable 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) enable
[ --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.

Regionalized private endpoint setting enabled.

The following command enables the regionalized private endpoint setting 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 enable

The previous command prints the following to the terminal.

Regionalized private endpoint setting enabled.
Give Feedback