Set Up a Private Endpoint
On this page
- Overview
- Required Access
- Considerations
- High Availability
- Port Ranges Used for Private Endpoints
- Private Endpoint-Aware Connection Strings
- Limitations
- Prerequisites
- Procedures
- Configure an Atlas Private Endpoint
- Connect to Atlas using a Private Endpoint
- View Private Endpoints
- Remove a Private Endpoint from Atlas
- Troubleshoot Private Endpoint Connection Issues
- Check the status of your AWS PrivateLink connections.
- Make sure that your security groups are configured properly.
- Check the status of your AWS PrivateLink connections.
- Make sure that your security groups are configured properly.
Note
This feature is not available for M0
free clusters, M2
, and
M5
clusters. To learn more about which features are unavailable,
see Atlas M0 (Free Cluster), M2, and M5 Limitations.
Overview
MongoDB Atlas supports private endpoints on dedicated clusters and serverless instances. Select your database deployment type to learn which cloud providers Atlas supports:
Required Access
To set up a private endpoint, you must have
Organization Owner
or Project Owner
access to
the project.
Considerations
High Availability
Port Ranges Used for Private Endpoints
Private Endpoint-Aware Connection Strings
Tip
Limitations
Prerequisites
To enable connections to Atlas using private endpoints, you must:
Have a valid payment method already configured for your organization.
Procedures
Configure an Atlas Private Endpoint
Use these resources to configure an Atlas private endpoint:
Private Endpoint Configuration Atlas CLI Commands
Note
For step-by-step instructions on configuring a private endpoint using the Atlas CLI, see the Atlas CLI tab on Set Up a Private Endpoint for a Dedicated Cluster.
Connect to Atlas using a Private Endpoint
Note
For important 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 database deployment with the following procedure: