Note
This feature is not available for Free clusters and Flex clusters. To learn more about which features are unavailable, see Atlas Free Cluster Limits.
After you set up a private endpoint for a cluster, follow these steps to manage and connect from your Atlas private endpoint.
To learn more about using private endpoints with Atlas, see Learn About Private Endpoints in Atlas.
Required Access
To view private endpoints, you must have Project Read Only access to the project.
To delete private endpoints, you must have Project Owner access or higher to the project.
Users with Organization Owner access must add themselves to the project as a Project Owner.
Considerations
For multi-region clusters, you must create a private endpoint for each region with a node.
If you're performing maintenance on a multi-region cluster, do not alter or remove private endpoints until maintenance is complete to avoid cluster downtime.
If you're moving from a multi-region to a single-region cluster, you can remove old private endpoints only after verifying that your cluster is fully functional in the new single-region setup and you've directed all traffic through the new single-region private endpoint.
For a full list of considerations, see Considerations.
Connect from a Private Endpoint
Important
For considerations about private endpoint-aware connection strings, see Private Endpoint-Aware Connection Strings.
Use a private endpoint-aware connection string to connect to an Atlas cluster with the following procedure:
In Atlas, go to the Clusters page for your project.
If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
In the sidebar, click Clusters under the Database heading.
The Clusters page displays.
Create a Database User.
Important
Skip this step if Atlas indicates in the Setup connection security step that you have at least one database user configured in your project. To manage existing database users, see Configure Database Users.
To access the cluster, you need a MongoDB user with access to the desired database or databases on the cluster in your project. If your project has no MongoDB users, Atlas prompts you to create a new user with the Atlas Admin role.
Enter the new user's Username.
Enter a Password for this new user or click Autogenerate Secure Password.
Click Create Database User to save the user.
Use this user to connect to your cluster in the following step.
Once you have added a database user, click Choose Your Connection Method.