Navigation

API Resources

Info With Circle IconCreated with Sketch.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 UsersRetrieves and edits the database users who have access to your MongoDB clusters.
Custom RolesRetrieves and edits custom roles, which specify a custom set of user privileges on your Atlas project.
Project IP Access ListRetrieves and edits the project IP access list, which controls client access to MongoDB clusters in a given Atlas project.
OrganizationsCreate, retrieve, or delete Atlas organizations.
InvoicesRetrieve invoices for any given Atlas organization.
ProjectsRetrieves or creates projects in any given Atlas organization.
TeamsRetrieves, creates, edits, or deletes teams for any given Atlas organization.
ClustersCreate, 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 ClustersAdd, remove, and retrieve namespaces, and add and remove custom zone mappings associated with Global Clusters.
AlertsRetrieves and acknowledges alerts.
Alert ConfigurationsRetrieves and edits alert configurations, which define the conditions that trigger alerts and the methods of notification.
Maintenance WindowsRetrieves and edits preferred maintenance windows. These windows set when you would prefer Atlas runs its regular maintenance.
LDAP ConfigurationCreate an LDAP configuration request for an Atlas project.
Atlas SearchRetrieves and edits Atlas Search index configurations and analyzers.
Legacy Backup SnapshotsEnables 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.
Legacy Backup Snapshot ScheduleView or edit the cluster's backup snapshot schedule.
Legacy Backup Restore JobCreate 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 Continuous Cloud Backup.
Cloud BackupView and delete backup snapshots for an Atlas cluster with Cloud Backups enabled.
Cloud Backup RestoreCreate or View restore jobs for an Atlas cluster with Cloud Backups enabled.
Cloud Backup Backup PolicyView and modify the snapshot schedule and retention settings for an Atlas cluster with Cloud Backups enabled.
Shared-Tier SnapshotsView backup snapshots for an M2 or M5 shared-tier Atlas cluster.
Shared-Tier Restore JobsView and create restore jobs from an M2 or M5 shared-tier Atlas cluster.
Legacy Backup CheckpointsRetrieve checkpoints metadata. Checkpoints are additional restore points for sharded clusters at points in time between regular snapshots.
Network PeeringAPI for managing VPC peering.
Private EndpointsAPI for managing private endpoints.
Personal API Key Whitelist (Deprecated)Retrieves and edits the API whitelist, which controls a user's access to the Atlas API.
Programmatic API KeysAPI for managing programmatic API keys.
Personal API Keys (Deprecated)API for managing user personal API keys (deprecated).
Monitoring and LogsRetrieve monitoring and logging data for MongoDB processes in a Atlas project.
Performance AdvisorRetrieve existing and suggested indexes for a deployment, as well as the namespaces on which slow queries were run and the queries that were slow. To learn about monitoring slow queries, see the Performance Advisor monitoring page.
AuditingView or edit the project's database auditing configuration.
Encryption at Rest using Customer Key ManagementEnable, disable, configure, and retrieve configuration for Encryption at Rest.
Atlas UsersCreate or manage Atlas users.
Cloud Provider AccessCreate or manage AWS IAM roles.
EventsRetrieve events for an Atlas organization or project.
Access TrackingView the list of all authentication attempts made against a cluster.
Data LakesManage the Data Lake configuration for a project.
Rolling IndexCreate a rolling index for a cluster.
Custom DNS for Atlas Clusters Deployed to AWSRetrieve and update custom DNS configuration for an Atlas project's clusters deployed to AWS .
TriggersManage Triggers.
Give Feedback