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:
The starting point for the Atlas API. | |
Retrieves and edits the database users who have access to your
MongoDB clusters. | |
Retrieves and edits custom roles,
which specify a custom set of user privileges on your Atlas
project. | |
Retrieves and edits the
project IP access list, which controls
client access to MongoDB clusters in a given Atlas project. | |
Retrieve, rename, or delete Atlas organizations. Invite
users to an organization. Update or delete invitations. | |
Retrieve invoices for any given Atlas organization. | |
Retrieves or creates projects in any given Atlas
organization. | |
Retrieves, creates, edits, or deletes teams for any given
Atlas organization. | |
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. | |
Create, retrieve, update, or delete a multi-cloud cluster in a
given Atlas project. | |
Create, retrieve, update, or delete a serverless instance in
a given Atlas project. | |
Add, remove, and retrieve namespaces, and add and remove custom
zone mappings associated with
Global Clusters. | |
Retrieves and acknowledges alerts. | |
Retrieves and edits alert configurations, which define the
conditions that trigger alerts and the methods of notification. | |
Retrieves and edits preferred maintenance windows. These windows
set when you would prefer Atlas runs its regular
maintenance. | |
Create an LDAP configuration request for an Atlas project. | |
Retrieves and edits Atlas Search index configurations and analyzers. | |
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. | |
View or edit the cluster's backup snapshot schedule. | |
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 Continuous Cloud Backup. | |
View and delete backup snapshots for an Atlas
cluster with Cloud Backups enabled. | |
Create or View restore jobs for an Atlas cluster with
Cloud Backups enabled. | |
View and modify the snapshot schedule and retention settings for
an Atlas cluster with Cloud Backups enabled. | |
View backup snapshots for an M2 or M5
shared cluster. | |
View and create restore jobs from an M2 or M5
shared cluster. | |
Retrieve checkpoints metadata. Checkpoints are additional
restore points for sharded clusters at points in time between
regular snapshots. | |
API for managing VPC peering. | |
API for managing private endpoints. | |
API for managing programmatic API keys. | |
Retrieve monitoring and logging data for MongoDB processes in a
Atlas project. | |
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. To learn about monitoring slow
queries, see the
Performance Advisor monitoring page. | |
View or edit the project's
database auditing configuration. | |
Enable, disable, configure, and retrieve configuration for
Encryption at Rest. | |
Create or manage Atlas users. | |
Create or manage AWS IAM roles. | |
Retrieve events for an Atlas organization or project. | |
View the list of all authentication attempts made against a
cluster. | |
Manage the Data Lake configuration for a project. | |
Create a rolling index
for a cluster. | |
Retrieve and update custom DNS configuration for an Atlas
project's clusters deployed to AWS. | |
Manage Triggers. | |
List, create, and validate live migrations of
deployments to Atlas. |
Give Feedback