• 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.

• Root
• Project IP Whitelist
  • Get Project IP Whitelist
  • Get Single Project IP Whitelist Entry
  • Add Entries to Project IP Whitelist
  • Update an Entry in the Project IP Whitelist
  • Delete an Entry from the Project IP Whitelist
• Database Users
  • Get All Database Users
  • Get a Single Database User
  • Create a Database User
  • Update a Database User
  • Delete a Database User
• Organizations
  • Get All Organizations
  • Get One Organization
  • Get All Organization Users
  • Create an Organization
  • Rename an Organization
  • Delete an Organization
  • Get All Invoices for One Organization
  • Get One Organization Invoice as CSV
  • Get All Projects in an Organization
• Projects
  • Get All Projects
  • Get One Project
  • Get One Project by Name
  • Create a Project
  • Get Teams Assigned to a Project
  • Add Teams to 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
  • Add Users to Team
  • Delete One Team
  • Remove a Team from a Project
  • Remove a User from a Team
• Clusters
  • Get All Clusters
  • Get a Single Cluster
  • Create a Cluster
  • Modify a Cluster
  • Delete a Cluster
• 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
• 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
• Snapshots
  • Get All Snapshots
  • Get a Snapshot
  • Change a Snapshot Expiration
  • Delete a Snapshot
• Snapshot Schedule
  • Get the Snapshot Schedule
  • Update Snapshot Schedule
• Restore Jobs
  • Get All Restore Jobs
  • Get One Restore Job
  • Create One Restore Job
• Checkpoints
  • Get All Checkpoints
  • Get One Checkpoint
• VPC
  • Get a List of Cloud Services Containers
  • Create a New Container
  • Get a Specific Container
  • Update a Container
  • Get a List of VPC Peering Connections
  • Create a New VPC Peering Connection
  • Get a Specific VPC Peering Connection
  • Update an Existing VPC Peering Connection
  • Delete an Existing VPC Peering Connection
• User API Whitelist
• User API Keys
  • Create a User API Key
  • Enable/Disable a User API Key
• 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
• Auditing
  • Get Auditing Configuration for a Project
  • Configure Auditing for a Project
• Retrieve your Atlas User ID

←   Configure Atlas API Access Root  →

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