atlas privateEndpoints regionalModes describe
On this page
Return the regionalized private endpoint setting for your project.
Use this command to check whether you can create multiple private resources per region.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
Command Syntax
atlas privateEndpoints regionalModes describe [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for describe | |
-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. |
Inherited Options
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ENABLED <Enabled>
Examples
# Return the regionalized private endpoint setting for the project with the ID 5e2211c17a3e5a48f5497de3: atlas privateEndpoints regionalModes describe --projectId 5e2211c17a3e5a48f5497de3 --output json