Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas privateEndpoints regionalModes enable

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output
  • Examples

Enable the regionalized private endpoint setting for your project.

This enables the ability to create multiple private resources per region in all cloud service providers for this project.

To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas privateEndpoints regionalModes enable [options]
Name
Type
Required
Description

-h, --help

false

help for enable

-o, --output

string

false

Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.

--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.

Regionalized private endpoint setting enabled.
# Enable the regionalied private endpoint setting in the project with the ID 5e2211c17a3e5a48f5497de3:
atlas privateEndpoints regionalModes enable --projectId 5e2211c17a3e5a48f5497de3 --output json

Back

disable