Navigation
  • 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.
Project IP Whitelist Retrieves and edits the project IP whitelist, which controls client access to MongoDB clusters in a given Atlas project.
Database Users Retrieves and edits the MongoDB users who have access to your MongoDB clusters.
Organizations Create, retrieve, or delete Atlas organizations.
Projects Retrieves or creates projects in any given Atlas organization.
Clusters Provides access to your MongoDB cluster configuration
Alerts Retrieves and acknowledges alerts.
Alert Configurations Retrieves and edits alert configurations, which define the conditions that trigger alerts and the methods of notification.
LDAP Configuration Create an LDAP configuration request for a Atlas project.
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.
Snapshot Schedule View or edit the cluster’s backup snapshot schedule.
Restore Jobs 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.
Checkpoints Retrieve checkpoints metadata. Checkpoints are additional restore points for sharded clusters at points in time between regular snapshots.
VPC API for managing VPC peering.
User API Whitelist Retrieves and edits the API whitelist, which controls a user’s access to the Atlas API.
User API Keys API for managing user API keys.
Monitoring and Logs Retrieve monitoring and logging data for MongoDB processes in a Atlas project.
Auditing View or edit the project’s database auditing configuration.
Retrieve your Atlas User ID Retrieve the unique user ID associated with your Atlas username.