• API >
• API Resources

API Resources

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

The Atlas API provides the resources listed here. The resources give programmatic access to Atlas’s features. For information on the API’s principles and conventions, see API.

The Atlas API provides the following resources:

Root	The starting point for the Atlas API.
Database Users	Retrieves and edits the MongoDB users who have access to your MongoDB clusters.
Custom MongoDB Roles	Retrieves and edits custom MongoDB roles, which specify a custom set of user privileges on your Atlas project.
Project IP Whitelist	Retrieves and edits the project IP whitelist, which controls client access to MongoDB clusters in a given Atlas project.
Organizations	Create, retrieve, or delete Atlas organizations.
Invoices	Retrieve invoices for any given Atlas organization.
Projects	Retrieves or creates projects in any given Atlas organization.
Teams	Retrieves, creates, edits, or deletes teams for any given Atlas organization.
Clusters	Create, retrieve, update, or delete a cluster in a given Atlas project. Retrieve or update advanced cluster options for a cluster in a given Atlas project.
Global Clusters	Add, remove, and retrieve namespaces, and add and remove custom zone mappings associated with Global Clusters.
Alerts	Retrieves and acknowledges alerts.
Alert Configurations	Retrieves and edits alert configurations, which define the conditions that trigger alerts and the methods of notification.
Maintenance Windows	Retrieves and edits preferred maintenance windows. These windows set when you would prefer Atlas runs its regular maintenance.
LDAP Configuration	Create an LDAP configuration request for a Atlas project.
Full Text Search	Retrieves and edits Full Text Search index configurations and analyzers.
Continuous Backup Snapshots	Enables you to view snapshot metadata, edit snapshot expiration dates, and remove existing snapshots. A snapshot is a backup of your data captured at a specific point in time.
Continuous Backup Snapshot Schedule	View or edit the cluster’s backup snapshot schedule.
Continuous Backup Restore Job	Create and retrieve restores jobs for a MongoDB cluster. A restore job restores a MongoDB cluster to its state from an existing snapshot or a specific point-in-time.
Cloud Provider and On-demand Snapshots	View and delete backup snapshots for an Atlas cluster with Cloud Provider Snapshots enabled.
Cloud Provider Snapshot Restore Job	Create or View restore jobs for an Atlas cluster with Cloud Provider Snapshots enabled.
Cloud Provider Snapshot Backup Policy	View and modify the snapshot schedule and retention settings for an Atlas cluster with Cloud Provider Snapshots enabled.
M2/M5 Snapshots	View backup snapshots for an M2 or M5 shared-tier Atlas cluster.
M2/M5 Snapshot Restore Jobs	View and create restore jobs from an M2 or M5 shared-tier Atlas cluster.
Checkpoints	Retrieve checkpoints metadata. Checkpoints are additional restore points for sharded clusters at points in time between regular snapshots.
Network Peering	API for managing VPC peering.
Private Endpoints	API for managing private endpoints.
Personal API Key Whitelist	Retrieves and edits the API whitelist, which controls a user’s access to the Atlas API.
Programmatic API Keys	API for managing programmatic API keys.
Personal API Keys (Deprecated)	API for managing user personal API keys (deprecated).
Monitoring and Logs	Retrieve monitoring and logging data for MongoDB processes in a Atlas project.
Performance Advisor	Retrieve existing and suggested indexes for a deployment, as well as the namespaces on which slow queries were run and the queries that were slow. For more information on monitoring slow queries, see the Performance Advisor monitoring page.
Auditing	View or edit the project’s database auditing configuration.
Encryption at Rest	Enable, disable, configure, and retrieve configuration for Encryption at Rest.
Atlas Users	Create or manage Atlas users.
Events	Retrieve events for an Atlas organization or project.
Access Tracking	View the list of all authentication attempts made against a cluster.
Data Lakes	Manage the +{data-lake-tenant}+ configuration for a project.

• Root
• Database Users
  • Get All Database Users
  • Get a Single Database User
  • Create a Database User
  • Update a Database User
  • Delete a Database User
• Custom MongoDB Roles
  • Get All Custom MongoDB Roles in a Project
  • Get a Single Custom MongoDB Role
  • Create a Custom MongoDB Role
  • Update a Custom MongoDB Role
  • Delete a Custom MongoDB Role
  • Custom Role Actions
• Project IP Whitelist
  • Get Project IP Whitelist
  • Get Single Project IP Whitelist Entry
  • Add Entries to Project IP Whitelist
  • Update Entries in the Project IP Whitelist
  • Delete an Entry from the Project IP Whitelist
• Organizations
  • Get All Organizations
  • Get One Organization
  • Get All Organization Users
  • Rename an Organization
  • Delete an Organization
  • Get All Projects in an Organization
• Invoices
  • Get All Invoices for One Organization
  • Get One Organization Invoice
  • Get Pending Invoice for an Organization
• Projects
  • Get All Projects
  • Get One Project
  • Get One Project by Name
  • Create a Project
  • Delete a Project
  • Get Teams Assigned to a Project
  • Add Teams to a Project
  • Remove One User from a Project
• Teams
  • Get All Teams
  • Get One Team by ID
  • Get One Team by Name
  • Get All Users Assigned to a Team
  • Create a Team
  • Rename a Team
  • Update Team Roles in One Project
  • Add Users to Team
  • Delete One Team
  • Remove a Team from a Project
  • Remove a User from a Team
• Clusters
  • Get All Clusters
  • Get One Cluster
  • Get Advanced Configuration Options for One Cluster
  • Create One Cluster
  • Modify a Cluster
  • Modify Advanced Configuration Options for One Cluster
  • Delete a Cluster
  • Test Failover
• Global Clusters
  • Get Global Clusters Data
  • Add a Managed Namespace
  • Delete a Managed Namespace
  • Add Custom Zone Mappings
  • Delete Custom Zone Mappings
• Alerts
  • Get All Alerts
  • Get an Alert
  • Acknowledge an Alert
• Alert Configurations
  • Get All Alert Configurations for a Group
  • Create an Alert Configuration
  • Get an Alert Configuration
  • Update an Alert Configuration
  • Enable/Disable Alert Configuration
  • Delete an Alert Configuration
  • Get Open Alerts for Alert Configuration
• Third-Party Integration Settings
  • Get All Configurations for Third-Party Service Integrations
  • Get the Configuration of a Third-Party Service Integration
  • Create a Configuration for a Third-Party Service Integration
  • Update a Configuration for a Third-Party Service Integration
  • Delete a Configuration for a Third-Party Service Integration
• Maintenance Windows
  • Get the Maintenance Window for One Project
  • Update One Maintenance Window
  • Defer Project Maintenance
  • Reset Maintenance Window
• X.509 Authentication for Database Users
  • Get X.509 Certificates for a User
  • Create an X.509 Certificate for a User
  • Get Current X.509 Configuration
  • Save an X.509 Configuration
  • Disable Customer-Managed X.509
• LDAP Configuration
  • Verify an LDAP Configuration
  • Get Status of a Request to Verify LDAP Configuration
  • Save an LDAP Configuration
  • Get Current LDAP Configuration
  • Delete an LDAP userToDNMapping
• Full Text Search
  • Get All Full Text Search Indexes for a Collection
  • Get One Full Text Search Index
  • Get All User-Defined Analyzers for a Cluster
  • Create a Full Text Search Index
  • Update a Full Text Search Index
  • Update All User-Defined Analyzers for a Cluster
  • Delete a Full Text Search Index
• Continuous Backup Snapshots
  • Get All Snapshots
  • Get a Snapshot
  • Change a Snapshot Expiration
  • Delete a Snapshot
• Continuous Backup Snapshot Schedule
  • Get the Snapshot Schedule
  • Update Snapshot Schedule
• Continuous Backup Restore Jobs
  • Get All Restore Jobs
  • Get One Restore Job
  • Create One Restore Job
• Cloud Provider and On-Demand Snapshots
  • Get All Cloud Provider Snapshots
  • Get One Cloud Provider Snapshot
  • Delete One Cloud Provider Snapshot
  • Take One On-Demand Snapshot
• Cloud Provider Snapshot Restore Jobs
  • Get All Cloud Provider Snapshot Restore Jobs
  • Get One Cloud Provider Snapshot Restore Job
  • Create a Cloud Provider Snapshot Restore Job
  • Cancel One Cloud Provider Snapshot Restore Job
• Cloud Provider Snapshot Backup Policy
  • Get Cloud Provider Snapshot Schedule
  • Modify Cloud Provider Snapshot Backup Policy
• M2/M5 Snapshots
  • Get All Snapshots for an M2/M5 Cluster
  • Get One Snapshot for an M2/M5 Cluster
  • Request to Download One M2/M5 Cluster Snapshot
• M2/M5 Snapshot Restore Jobs
  • Get All Restore Jobs for an M2/M5 Cluster
  • Get One Restore Job for an M2/M5 Cluster
  • Create a Restore Job from an M2/M5 Cluster
• Checkpoints
  • Get All Checkpoints
  • Get One Checkpoint
• Network Peering
  • Get Network Peering Containers in a Project by Cloud Provider
  • Get a Specific Network Peering Container
  • Create a New Network Peering Container
  • Update A Network Peering Container
  • Delete One Network Peering Container
  • Get All Network Peering Connections in A Project
  • Get One Network Peering Connection in a Project
  • Create One New Network Peering Connection
  • Update One New Network Peering Connection
  • Delete One Existing Network Peering Connection
  • Verify Connect via Peering Only Mode for a Project
  • Enable Connect via Peering Only Mode for a Project
• Private Endpoints
  • Get All Private Endpoint Connections
  • Create One Private Endpoint Connection
  • Get One Private Endpoint Connection by ID
  • Delete One Private Endpoint Connection
  • Add One Interface Endpoint to a Private Endpoint Connection
  • Get One Interface Endpoint by ID
  • Delete One Interface Endpoint
• Programmatic API Keys
  • Get All Organization API Keys
  • Get One Organization API Key
  • Get All Whitelist Entries for One Organization API Key
  • Get One Whitelist Entry for One Organization API Key
  • Create One Organization API Key
  • Create Whitelist Entries for One Organization API Key
  • Update One Organization API Key
  • Delete One Whitelist Entry for One Organization API Key
  • Delete One Organization API Key
  • Get All Organization API Keys Assigned to One Project
  • Create and Assign One Organization API Key to One Project
  • Assign One Organization API Key to One Project
  • Modify Roles of One Organization API Key to One Project
  • Unassign One Organization API Key from One Project
• Personal API Keys (Deprecated)
  • Get All API Keys for User
  • Enable/Disable a User API Key
  • Delete a User API Key
  • Personal API Key Whitelist
• Monitoring and Logs
  • Get All MongoDB Processes in a Group
  • Get MongoDB Process by ID
  • Get Measurements for a MongoDB Process
  • Get Available Databases for a MongoDB Process
  • Get Measurements of a Database for a MongoDB Process
  • Get Available Disks for a MongoDB Process
  • Get Measurements of a Disk for a MongoDB Process
  • Logs
• Performance Advisor
  • Get All Namespaces for a Host
  • Get Existing Indexes for a Host
  • Get Slow Queries
  • Get Suggested Indexes
• Auditing
  • Get Auditing Configuration for a Project
  • Configure Auditing for a Project
• Encryption at Rest
  • Enable and Configure Encryption at Rest for a Project
  • Get Configuration for Encryption at Rest for a Project
• Atlas Users
  • Get All Users in One Project
  • Get an Atlas user by ID
  • Get an Atlas User by Name
  • Create an Atlas User
  • Update an Atlas User
• Events
  • Get All Organization Events
  • Get One Organization Event
  • Get All Project Events
  • Get One Project Event
• Performance Advisor
  • Get All Namespaces for a Host
  • Get Existing Indexes for a Host
  • Get Slow Queries
  • Get Suggested Indexes
• Access Tracking
  • Get Database Access History by Cluster Name
  • Get Database Access History for a Cluster by Hostname
• Data Lakes
  • Get All Data Lakes
  • Get One Data Lake
  • Create One Data Lake
  • Update One Data Lake
  • Delete One Data Lake

←   Configure Atlas API Access Root  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.