Docs Home → MongoDB Atlas for Government
API
On this page
- Example Usage
- See the Atlas Documentation
- Creating a Project
- Atlas for Government Considerations
- Database Users
- Clusters
- Alerts
- Third-Party Integration Settings
- Cloud Backups
- Shared-Tier Snapshots and Restore Jobs
- Online Archive
- Network Peering
- Private Endpoints
- Monitoring and Logs
- Encryption at Rest using Customer Key Management
- Atlas Users
- Cloud Provider Access
- Triggers
The MongoDB Atlas for Government API functions in the same way as the Atlas API, except that it uses the following base URL:
https://cloud.mongodbgov.com/api/atlas/v1.0
AtlasGov authenticates API requests with SHA-256 using
HTTP Digest Authentication.
Example Usage
This curl example retrieves database users for a project:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodbgov.com/api/atlas/v1.0/groups/{PROJECT-ID}/databaseUsers?pretty=true"
You can find your
PROJECT-IDin your Project Settings.You can generate an API key pair in your organization's Access Manager, under the API Keys tab.
See the Atlas Documentation
To learn more about using the API, see the Atlas API.
To configure the API, see Configure Atlas API Access.
For a list of possible errors, see Atlas API Error Codes.
Creating a Project
You must designate projects for either standard or government
(gov) region usage upon creation. You cannot deploy clusters
across government and standard regions in the same project. AWS
is the only cloud provider for AtlasGov.
By default, the AtlasGov API designates new projects for standard region usage.
To use the API to create a project for government regions, include
the following in your POST request data:
"regionUsageRestrictions" : "GOV_REGIONS_ONLY"
Tip
Atlas documentation
For detailed information on creating a project with the API, including an example request, see Create One Project.
Atlas for Government Considerations
The following cloud providers, MongoDB products, and features are unavailable for all API resources:
Azure
GCP
Atlas Data Lake
Atlas Online Archives
Atlas Triggers
MongoDB Charts
MongoDB Realm
Free, shared, and
M10clusters
Many of the commercial Atlas API resources are limited or unavailable:
Database Users
Database users who authenticate with
SCRAM must use SCRAM-SHA-256.
Clusters
AtlasGov clusters must be tier M20 or higher. Free and
shared-tier clusters are not supported.
Alerts
Alerts related to payment methods are unavailable.
Alerts can come from several different email addresses. For more information, see Alerts and Communications.
Third-Party Integration Settings
You must have the Project Owner role to
configure a third-party monitoring integration.
Datadog
When integrated with Datadog, AtlasGov uses the Datadog for Government site (US1-FED).
To learn more about US1-FED, see the Datadog documentation.
Cloud Backups
AWS Standard and AWS GovCloud backups are not compatible with one another. If you create a backup from a AWS GovCloud region-only project, you can only restore that data to a AWS GovCloud region-only project. The same is true for AWS Standard region-only projects.
Shared-Tier Snapshots and Restore Jobs
Shared-tier clusters are unavailable in AtlasGov.
Online Archive
Online Archives are unavailable in AtlasGov.
Network Peering
You can only peer AWS GovCloud regions with MongoDB clusters in AWS GovCloud regions. You can only peer AWS Standard regions with MongoDB clusters in AWS Standard regions.
AWS is the only supported cloud provider for AtlasGov.
Private Endpoints
You can only link AWS GovCloud regions with MongoDB clusters in AWS GovCloud regions. You can only link AWS Standard regions with MongoDB clusters in AWS Standard regions.
AWS is the only supported cloud provider for AtlasGov.
Monitoring and Logs
In addition to the standard Atlas logging, AtlasGov logs the username and IP address associated with all failed login attempts, temporary lockouts and failed API digest authentications.
Encryption at Rest using Customer Key Management
You must use KMS keys in AWS GovCloud regions to encrypt data in AWS GovCloud region-only projects. You must use KMS keys in AWS Standard regions to encrypt data in AWS Standard region-only projects.
AWS is the only supported cloud provider for AtlasGov.
Atlas Users
You cannot create MongoDB Atlas for Government users. MongoDB Atlas for Government is available by invitation only.
Cloud Provider Access
AWS is the only supported cloud provider for AtlasGov.
Triggers
Triggers are unavailable in AtlasGov.