Docs Menu
Docs Home
/ /
Atlas Command Line Interface
/ / /

atlas privateEndpoints regionalModes describe

Return the regionalized private endpoint setting for your project.

Use this command to check whether you can create multiple private resources per region.

atlas privateEndpoints regionalModes describe [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.

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

Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

# Return the regionalized private endpoint setting for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas privateEndpoints regionalModes describe --projectId 5e2211c17a3e5a48f5497de3 --output json

Back

regionalModes

On this page