MongoDB Atlas Administration API
The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. The Atlas Administration API supports OAuth2 Service…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.
The Atlas Administration API supports OAuth2 Service Accounts and HTTP Digest-based API keys. Service accounts are the recommended authentication method and API keys are considered a legacy option.
To authenticate with a Service Account, first exchange its client ID and secret for an access token using the OAuth 2.0 Client Credentials flow. Atlas provides a token endpoint at POST https://cloud.mongodb.com/api/oauth/token, which returns a Bearer token that is reusable and valid for 1 hour (3600 seconds).
For example, to return a list of your organizations with cURL, first generate an access token and then use that token to call the same Atlas Administration API endpoint shown in the current example:
ACCESS_TOKEN=$(curl -fsS --request POST https://cloud.mongodb.com/api/oauth/token \
--header "Authorization: Basic $(printf '%s' "${CLIENT_ID}:${CLIENT_SECRET}" | base64 | tr -d '\n')" \
--header "Content-Type: application/x-www-form-urlencoded" \
--header "Accept: application/json" \
--data "grant_type=client_credentials" | jq -r '.access_token')
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true"If your organization requires an IP access list for the Atlas Administration API, the token can be created from any IP address, but the API call that uses the token must originate from an allowed IP.
To learn more, see Get Started with the Atlas Administration API. For support, see MongoDB Support.
You can also explore the various endpoints available through the Atlas Administration API in MongoDB's Postman workspace (requires a Postman account).
Endpoints 400
Access Tracking
- GETReturn Database Access History for One Cluster by Cluster Name
/api/atlas/v2/groups/:groupId/dbAccessHistory/clusters/:clusterNameReturns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You… - GETReturn Database Access History for One Cluster by Hostname
/api/atlas/v2/groups/:groupId/dbAccessHistory/processes/:hostnameReturns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters.…
Activity Feed
- GETReturn Pre-Filtered Activity Feed Link for One Project
/api/atlas/v2/groups/:groupId/activityFeedReturns a pre-filtered activity feed link for the specified project based on the provided date range and event types. The returned link can be shared and… - GETReturn Pre-Filtered Activity Feed Link for One Organization
/api/atlas/v2/orgs/:orgId/activityFeedReturns a pre-filtered activity feed link for the specified organization based on the provided date range and event types. The returned link can be shared and…
AI Model API Keys
- GETReturn AI Model API Keys for One Group
/api/atlas/v2/groups/:groupId/aiModelApiKeysRetrieve AI model API keys for the given group. - POSTCreate New AI Model API Key
/api/atlas/v2/groups/:groupId/aiModelApiKeysCreate a new AI model API key for the given group. - GETReturn Single AI Model API Key for One Group
/api/atlas/v2/groups/:groupId/aiModelApiKeys/:apiKeyIdRetrieve a single AI model API key for the given group. - DELETEDelete Existing AI Model API Key
/api/atlas/v2/groups/:groupId/aiModelApiKeys/:apiKeyIdDelete an existing AI model API key in the given group. - PATCHUpdate Existing AI Model API Key
/api/atlas/v2/groups/:groupId/aiModelApiKeys/:apiKeyIdUpdate an existing AI model API key in the given group. Only the name can be updated; scope is immutable after creation. - GETReturn AI Model API Keys for One Organization
/api/atlas/v2/orgs/:orgId/aiModelApiKeysRetrieve AI model API keys for the given organization. - GETReturn Single AI Model API Key for One Organization
/api/atlas/v2/orgs/:orgId/aiModelApiKeys/:apiKeyIdRetrieve a single AI model API key for the given organization.
AI Model Rate Limits
- GETReturn Single AI Model Rate Limit for One Group
/api/atlas/v2/groups/:groupId/aiModelApiClouds/:cloud/geographies/:geography/modelGroupNames/:modelGroupName/rateLimitsRetrieve a single scoped AI model rate limit for the given group. - PATCHUpdate AI Model Rate Limit
/api/atlas/v2/groups/:groupId/aiModelApiClouds/:cloud/geographies/:geography/modelGroupNames/:modelGroupName/rateLimitsUpdate a scoped AI model rate limit for the given model group. - POSTReset AI Model Rate Limit for One Model Group
/api/atlas/v2/groups/:groupId/aiModelApiClouds/:cloud/geographies/:geography/modelGroupNames/:modelGroupName/rateLimits:resetReset the scoped AI model rate limit for the given model group to default values. - GETReturn AI Model Rate Limits for One Group
/api/atlas/v2/groups/:groupId/aiModelApiRateLimitsRetrieve AI model rate limits for the given group. - POSTReset AI Model Rate Limits for Group
/api/atlas/v2/groups/:groupId/aiModelApiRateLimits:resetReset the AI Model rate limits for the given group to default values. - GETReturn Single AI Model Rate Limit for One Organization
/api/atlas/v2/orgs/:orgId/aiModelApiClouds/:cloud/geographies/:geography/modelGroupNames/:modelGroupName/rateLimitsRetrieve a single scoped AI model rate limit for the given organization. - GETReturn AI Model Rate Limits for One Organization
/api/atlas/v2/orgs/:orgId/aiModelApiRateLimitsRetrieve AI model rate limits for the given organization.
Alert Configurations
- GETReturn All Alert Configuration Matchers Field Names
/api/atlas/v2/alertConfigs/matchers/fieldNamesGet all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint… - GETReturn All Alert Configurations in One Project
/api/atlas/v2/groups/:groupId/alertConfigsReturns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers… - POSTCreate One Alert Configuration in One Project
/api/atlas/v2/groups/:groupId/alertConfigsCreates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. This resource remains… - GETReturn One Alert Configuration from One Project
/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigIdReturns the specified alert configuration from the specified project. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert… - PUTUpdate One Alert Configuration in One Project
/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigIdUpdates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. NOTE: To enable or… - DELETERemove One Alert Configuration from One Project
/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigIdRemoves one alert configuration from the specified project. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert… - PATCHToggle State of One Alert Configuration in One Project
/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigIdEnables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled.… - GETReturn All Alert Configurations Set for One Alert
/api/atlas/v2/groups/:groupId/alerts/:alertId/alertConfigsReturns all alert configurations set for the specified alert. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the…
Alerts
- GETReturn All Open Alerts for One Alert Configuration
/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigId/alertsReturns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations… - GETReturn All Alerts from One Project
/api/atlas/v2/groups/:groupId/alertsReturns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set.… - GETReturn One Alert from One Project
/api/atlas/v2/groups/:groupId/alerts/:alertIdReturns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. Use… - PATCHAcknowledge One Alert from One Project
/api/atlas/v2/groups/:groupId/alerts/:alertIdConfirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You…
Atlas Search
- POSTCreate One Atlas Search Index
/api/atlas/v2/groups/:groupId/clusters/:clusterName/fts/indexesDeprecated. Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers… - GETReturn All Atlas Search Indexes for One Collection
/api/atlas/v2/groups/:groupId/clusters/:clusterName/fts/indexes/:databaseName/:collectionNameDeprecated. Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the… - GETReturn One Atlas Search Index
/api/atlas/v2/groups/:groupId/clusters/:clusterName/fts/indexes/:indexIdDeprecated. Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed… - DELETERemove One Atlas Search Index
/api/atlas/v2/groups/:groupId/clusters/:clusterName/fts/indexes/:indexIdDeprecated. Removes one Atlas Search index that you identified with its unique ID. - PATCHUpdate One Atlas Search Index
/api/atlas/v2/groups/:groupId/clusters/:clusterName/fts/indexes/:indexIdDeprecated. Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the… - GETReturn All Search Nodes
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/deploymentReturns the Search Nodes for the specified cluster. Deprecated versions: v2-{2024-05-30}, v2-{2023-01-01} - POSTCreate Search Nodes
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/deploymentCreates Search Nodes for the specified cluster. - DELETEDelete Search Nodes
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/deploymentDeletes the Search Nodes for the specified cluster. - PATCHUpdate Search Nodes
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/deploymentUpdates the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01} - GETReturn All Atlas Search Indexes for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexesReturns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. - POSTCreate One Atlas Search Index
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexesCreates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when… - GETReturn All Atlas Search Indexes for One Collection
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexes/:databaseName/:collectionNameReturns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. - GETReturn One Atlas Search Index by Name
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexes/:databaseName/:collectionName/:indexNameReturns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the… - DELETERemove One Atlas Search Index by Name
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexes/:databaseName/:collectionName/:indexNameRemoves one Atlas Search index that you identified with its database, collection, and name. This deletion is eventually consistent. - PATCHUpdate One Atlas Search Index by Name
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexes/:databaseName/:collectionName/:indexNameUpdates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to… - GETReturn One Atlas Search Index by ID
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexes/:indexIdReturns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the… - DELETERemove One Atlas Search Index by ID
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexes/:indexIdRemoves one Atlas Search index that you identified with its unique ID. This deletion is eventually consistent. - PATCHUpdate One Atlas Search Index by ID
/api/atlas/v2/groups/:groupId/clusters/:clusterName/search/indexes/:indexIdUpdates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers…
Auditing
- GETReturn Auditing Configuration for One Project
/api/atlas/v2/groups/:groupId/auditLogReturns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. This… - PATCHUpdate Auditing Configuration for One Project
/api/atlas/v2/groups/:groupId/auditLogUpdates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. This…
AWS Clusters DNS
- GETReturn One Custom DNS Configuration for Atlas Clusters on AWS
/api/atlas/v2/groups/:groupId/awsCustomDNSReturns the custom DNS configuration for AWS clusters in the specified project. - PATCHUpdate State of One Custom DNS Configuration for Atlas Clusters on AWS
/api/atlas/v2/groups/:groupId/awsCustomDNSEnables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS…
Cloud Backups
- GETReturn Object Storage Private Endpoints for Cloud Backups for One Cloud Provider in One Project
/api/atlas/v2/groups/:groupId/backup/:cloudProvider/privateEndpointsReturns the private endpoints of the specified cloud provider for object storage backup operations. - POSTCreate One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project
/api/atlas/v2/groups/:groupId/backup/:cloudProvider/privateEndpointsCreates a private endpoint in the specified region for secure, private connectivity between Atlas and cloud provider object storage services for backup… - GETReturn One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project
/api/atlas/v2/groups/:groupId/backup/:cloudProvider/privateEndpoints/:endpointIdReturns one private endpoint, identified by its ID, for object storage backup operations. - DELETEDelete One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider from One Project
/api/atlas/v2/groups/:groupId/backup/:cloudProvider/privateEndpoints/:endpointIdDeletes one private endpoint, identified by its ID, for object storage backup operations. - GETReturn All Snapshot Export Buckets
/api/atlas/v2/groups/:groupId/backup/exportBucketsReturns all Export Buckets associated with the specified Project. Deprecated versions: v2-{2023-01-01} - POSTCreate One Snapshot Export Bucket
/api/atlas/v2/groups/:groupId/backup/exportBucketsCreates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be… - GETReturn One Snapshot Export Bucket
/api/atlas/v2/groups/:groupId/backup/exportBuckets/:exportBucketIdReturns one Export Bucket associated with the specified Project. Deprecated versions: v2-{2023-01-01} - DELETEDelete One Snapshot Export Bucket
/api/atlas/v2/groups/:groupId/backup/exportBuckets/:exportBucketIdDeletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. - PATCHUpdate One Export Bucket Private Networking Settings
/api/atlas/v2/groups/:groupId/backup/exportBuckets/:exportBucketIdUpdates the private networking settings for one snapshot export bucket in the specified project. - GETReturn Backup Compliance Policy Settings
/api/atlas/v2/groups/:groupId/backupCompliancePolicyReturns the Backup Compliance Policy settings with the specified project. Deprecated versions: v2-{2023-01-01} - PUTUpdate Backup Compliance Policy Settings
/api/atlas/v2/groups/:groupId/backupCompliancePolicyUpdates the Backup Compliance Policy settings for the specified project. Deprecated versions: v2-{2023-01-01} - DELETEDisable Backup Compliance Policy Settings
/api/atlas/v2/groups/:groupId/backupCompliancePolicyDisables the Backup Compliance Policy settings with the specified project. As a prerequisite, a support ticket needs to be file first, instructions in… - GETReturn All Snapshot Export Jobs
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/exportsReturns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. - POSTCreate One Snapshot Export Job
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/exportsExports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. - GETReturn One Snapshot Export Job
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/exports/:exportIdReturns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. - GETReturn All Restore Jobs for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/restoreJobsReturns all cloud backup restore jobs for one cluster from the specified project. - POSTCreate One Restore Job of One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/restoreJobsRestores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If… - GETReturn One Restore Job for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/restoreJobs/:restoreJobIdReturns one cloud backup restore job for one cluster from the specified project. - DELETECancel One Restore Job for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/restoreJobs/:restoreJobIdCancels one cloud backup restore job of one cluster from the specified project. - GETReturn One Cloud Backup Schedule
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/scheduleReturns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots… - DELETERemove All Cloud Backup Schedules
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/scheduleRemoves all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those… - PATCHUpdate Cloud Backup Schedule for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/scheduleUpdates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how… - GETReturn All Replica Set Cloud Backups
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshotsReturns all snapshots of one cluster from the specified project. - POSTTake One On-Demand Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshotsTakes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an… - GETReturn One Replica Set Cloud Backup
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/:snapshotIdReturns one snapshot from the specified cluster. - DELETERemove One Replica Set Cloud Backup
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/:snapshotIdRemoves the specified snapshot. - PATCHUpdate Expiration Date for One Cloud Backup
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/:snapshotIdChanges the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting Service Account or API Key must have the… - GETReturn Databases in One Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/:snapshotId/databasesReturns the list of databases that exist in the specified snapshot. Use this to discover namespaces before creating a collection restore job. - GETReturn One Database in One Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/:snapshotId/databases/:databaseNameReturns one database that exists in the specified snapshot. Use this to confirm a known database exists before referencing it in a collection restore job. - GETReturn Collections in One Database in One Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/:snapshotId/databases/:databaseName/collectionsReturns the list of collections in the specified database that exist in the snapshot. Use this to discover namespaces before creating a collection restore job. - GETReturn One Collection in One Database in One Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/:snapshotId/databases/:databaseName/collections/:collectionNameReturns one collection that exists in the specified database in the snapshot. Use this to confirm a known collection exists before referencing it in a… - GETReturn One Sharded Cluster Cloud Backup
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/shardedCluster/:snapshotIdReturns one snapshot of one sharded cluster from the specified project. - DELETERemove One Sharded Cluster Cloud Backup
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/shardedCluster/:snapshotIdRemoves one snapshot of one sharded cluster from the specified project. - GETReturn All Sharded Cluster Cloud Backups
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backup/snapshots/shardedClustersReturns all snapshots of one sharded cluster from the specified project. - GETReturn All Collection Restore Jobs for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collectionRestoreJobsReturns all collection restore jobs for one cluster from the specified project. - POSTCreate One Collection Restore Job
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collectionRestoreJobsCreates one collection-level restore job for one cluster from the specified project. Collection-level restores allow restoring specific databases or… - GETReturn One Collection Restore Job for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collectionRestoreJobs/:jobIdReturns one collection restore job for one cluster from the specified project. - GETReturn All Collection States for One Collection Restore Job
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collectionRestoreJobs/:jobId/collectionsReturns all collection-level restore states for one collection restore job from the specified project. Note: If the restore job is in the INITIALIZING state,… - GETReturn One Collection State for One Collection Restore Job
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collectionRestoreJobs/:jobId/collections/:sourceNamespaceReturns one collection-level restore state for one collection restore job from the specified project.
Cloud Migration Service
- POSTCreate One Migration for One Local Managed Cluster to MongoDB Atlas
/api/atlas/v2/groups/:groupId/liveMigrationsMigrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. Please make sure to validate your migration before initiating it. You can use this API… - GETReturn One Migration Job
/api/atlas/v2/groups/:groupId/liveMigrations/:liveMigrationIdReturn details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to… - PUTCut Over One Migrated Cluster
/api/atlas/v2/groups/:groupId/liveMigrations/:liveMigrationId/cutoverCut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration… - POSTValidate One Migration Request
/api/atlas/v2/groups/:groupId/liveMigrations/validateVerifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check… - GETReturn One Migration Validation Job
/api/atlas/v2/groups/:groupId/liveMigrations/validate/:validationIdReturn the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. - GETReturn All Projects Available for Migration
/api/atlas/v2/orgs/:orgId/liveMigrations/availableProjectsReturn all projects that you can migrate to the specified organization. - POSTCreate One Link-Token
/api/atlas/v2/orgs/:orgId/liveMigrations/linkTokensCreate one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live… - DELETERemove One Link-Token
/api/atlas/v2/orgs/:orgId/liveMigrations/linkTokensRemove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let…
Cloud Provider Access
- GETReturn All Cloud Provider Access Roles
/api/atlas/v2/groups/:groupId/cloudProviderAccessReturns all cloud provider access roles with access to the specified project. - POSTCreate One Cloud Provider Access Role
/api/atlas/v2/groups/:groupId/cloudProviderAccessCreates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. For the GCP… - DELETEDeauthorize One Cloud Provider Access Role
/api/atlas/v2/groups/:groupId/cloudProviderAccess/:cloudProvider/:roleIdRevokes access to the specified project for the specified access role. - GETReturn One Cloud Provider Access Role
/api/atlas/v2/groups/:groupId/cloudProviderAccess/:roleIdReturns the access role with the specified id and with access to the specified project. - PATCHAuthorize One Cloud Provider Access Role
/api/atlas/v2/groups/:groupId/cloudProviderAccess/:roleIdGrants access to the specified project for the specified access role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud…
Cluster Outage Simulation
- GETReturn One Outage Simulation
/api/atlas/v2/groups/:groupId/clusters/:clusterName/outageSimulationReturns one outage simulation for one cluster. - POSTStart One Outage Simulation
/api/atlas/v2/groups/:groupId/clusters/:clusterName/outageSimulationStarts a cluster outage simulation. - DELETEEnd One Outage Simulation
/api/atlas/v2/groups/:groupId/clusters/:clusterName/outageSimulationEnds a cluster outage simulation.
Clusters
- GETReturn All Authorized Clusters in All Projects
/api/atlas/v2/clustersReturns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response… - GETReturn All Clusters in One Project
/api/atlas/v2/groups/:groupId/clustersReturns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The… - POSTCreate One Cluster in One Project
/api/atlas/v2/groups/:groupId/clustersCreates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with… - GETReturn One Cluster from One Project
/api/atlas/v2/groups/:groupId/clusters/:clusterNameReturns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes… - DELETERemove One Cluster from One Project
/api/atlas/v2/groups/:groupId/clusters/:clusterNameRemoves one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. This feature is not available… - PATCHUpdate One Cluster in One Project
/api/atlas/v2/groups/:groupId/clusters/:clusterNameUpdates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update… - GETReturn Adaptive Settings for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/adaptiveSettingsReturns the Adaptive Settings for the specified cluster, including client-provided overrides and the effective settings derived from those overrides and… - PATCHUpdate Adaptive Settings for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/adaptiveSettingsUpdates the client-provided Adaptive Settings overrides for the specified cluster and returns the resulting Adaptive Settings, including the effective… - GETReturn Auto Scaling Configuration for One Sharded Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/autoScalingConfigurationDeprecated. Returns the internal configuration of AutoScaling for sharded clusters. This endpoint can be used for diagnostic purposes to ensure that sharded… - GETReturn Advanced Configuration Options for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/processArgsReturns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set.… - PATCHUpdate Advanced Configuration Options for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/processArgsUpdates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set.… - POSTTest Failover for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/restartPrimariesStarts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test… - GETReturn Status of All Cluster Operations
/api/atlas/v2/groups/:groupId/clusters/:clusterName/statusReturns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has… - POSTGrant MongoDB Employee Cluster Access for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName:grantMongoDBEmployeeAccessGrants MongoDB employee cluster access for the given duration and at the specified level for one cluster. - POSTPin Feature Compatibility Version for One Cluster in One Project
/api/atlas/v2/groups/:groupId/clusters/:clusterName:pinFeatureCompatibilityVersionPins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. If an FCV pin already exists for the cluster,… - POSTRevoke MongoDB Employee Cluster Access for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName:revokeMongoDBEmployeeAccessRevokes a previously granted MongoDB employee cluster access. - POSTUnpin Feature Compatibility Version for One Cluster in One Project
/api/atlas/v2/groups/:groupId/clusters/:clusterName:unpinFeatureCompatibilityVersionUnpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. - GETReturn All Cloud Provider Regions
/api/atlas/v2/groups/:groupId/clusters/provider/regionsReturns the list of regions available for the specified cloud provider at the specified tier. - POSTUpgrade One Shared-Tier Cluster
/api/atlas/v2/groups/:groupId/clusters/tenantUpgradeUpgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. Each project supports up to 25 clusters. This endpoint can also… - POSTUpgrade One Shared-Tier Cluster to One Serverless Instance
/api/atlas/v2/groups/:groupId/clusters/tenantUpgradeToServerlessDeprecated. This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the Upgrade… - POSTLoad Sample Dataset into One Cluster
/api/atlas/v2/groups/:groupId/sampleDatasetLoad/:nameRequests loading the MongoDB sample dataset into the specified cluster. - GETReturn Status of Sample Dataset Load for One Cluster
/api/atlas/v2/groups/:groupId/sampleDatasetLoad/:sampleDatasetIdChecks the progress of loading the sample dataset into one cluster.
Collection Level Metrics
- GETReturn Cluster-Level Query Latency
/api/atlas/v2/groups/:groupId/clusters/:clusterName/:clusterView/:databaseName/:collectionName/collStats/measurementsGet a list of the Coll Stats Latency cluster-level measurements for the given namespace. - GETReturn Ranked Namespaces from One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/:clusterView/collStats/namespacesReturn the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. - GETReturn Pinned Namespaces
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collStats/pinnedReturns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. - PUTPin Namespaces
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collStats/pinnedPin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or… - PATCHAdd Pinned Namespaces
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collStats/pinnedAdd provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. - PATCHUnpin Namespaces
/api/atlas/v2/groups/:groupId/clusters/:clusterName/collStats/unpinUnpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. - GETReturn All Metric Names
/api/atlas/v2/groups/:groupId/collStats/metricsReturns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. - GETReturn Host-Level Query Latency
/api/atlas/v2/groups/:groupId/processes/:processId/:databaseName/:collectionName/collStats/measurementsGet a list of the Coll Stats Latency process-level measurements for the given namespace. - GETReturn Ranked Namespaces from One Host
/api/atlas/v2/groups/:groupId/processes/:processId/collStats/namespacesReturn the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window.
Custom Database Roles
- GETReturn All Custom Roles in One Project
/api/atlas/v2/groups/:groupId/customDBRoles/rolesReturns all custom roles for the specified project. - POSTCreate One Custom Role
/api/atlas/v2/groups/:groupId/customDBRoles/rolesCreates one custom role in the specified project. - GETReturn One Custom Role in One Project
/api/atlas/v2/groups/:groupId/customDBRoles/roles/:roleNameReturns one custom role for the specified project. - DELETERemove One Custom Role from One Project
/api/atlas/v2/groups/:groupId/customDBRoles/roles/:roleNameRemoves one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions.… - PATCHUpdate One Custom Role in One Project
/api/atlas/v2/groups/:groupId/customDBRoles/roles/:roleNameUpdates one custom role in the specified project.
Data Federation
- GETReturn All Federated Database Instances in One Project
/api/atlas/v2/groups/:groupId/dataFederationReturns the details of all federated database instances in the specified project. - POSTCreate One Federated Database Instance in One Project
/api/atlas/v2/groups/:groupId/dataFederationCreates one federated database instance in the specified project. - GETReturn One Federated Database Instance in One Project
/api/atlas/v2/groups/:groupId/dataFederation/:tenantNameReturns the details of one federated database instance within the specified project. - DELETERemove One Federated Database Instance from One Project
/api/atlas/v2/groups/:groupId/dataFederation/:tenantNameRemoves one federated database instance from the specified project. - PATCHUpdate One Federated Database Instance in One Project
/api/atlas/v2/groups/:groupId/dataFederation/:tenantName?skipRoleValidation=trueUpdates the details of one federated database instance in the specified project. - GETReturn All Query Limits for One Federated Database Instance
/api/atlas/v2/groups/:groupId/dataFederation/:tenantName/limitsReturns query limits for a federated databases instance in the specified project. - GETReturn One Federated Database Instance Query Limit for One Project
/api/atlas/v2/groups/:groupId/dataFederation/:tenantName/limits/:limitNameReturns the details of one query limit for the specified federated database instance in the specified project. - DELETEDelete One Query Limit for One Federated Database Instance
/api/atlas/v2/groups/:groupId/dataFederation/:tenantName/limits/:limitNameDeletes one query limit for one federated database instance. - PATCHConfigure One Query Limit for One Federated Database Instance
/api/atlas/v2/groups/:groupId/dataFederation/:tenantName/limits/:limitNameCreates or updates one query limit for one federated database instance. - GETDownload Query Logs for One Federated Database Instance
/api/atlas/v2/groups/:groupId/dataFederation/:tenantName/queryLogs.gzDownloads the query logs for the specified federated database instance. The API does not support direct calls with the json response schema. You must request… - GETReturn All Federated Database Instance and Online Archive Private Endpoints in One Project
/api/atlas/v2/groups/:groupId/privateNetworkSettings/endpointIdsReturns all private endpoints for Federated Database Instances and Online Archives in the specified project. - POSTCreate One Federated Database Instance and Online Archive Private Endpoint for One Project
/api/atlas/v2/groups/:groupId/privateNetworkSettings/endpointIdsAdds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated… - GETReturn One Federated Database Instance and Online Archive Private Endpoint in One Project
/api/atlas/v2/groups/:groupId/privateNetworkSettings/endpointIds/:endpointIdReturns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. - DELETERemove One Federated Database Instance and Online Archive Private Endpoint from One Project
/api/atlas/v2/groups/:groupId/privateNetworkSettings/endpointIds/:endpointIdRemoves one private endpoint for Federated Database Instances and Online Archives in the specified project.
Database Users
- GETReturn All Database Users in One Project
/api/atlas/v2/groups/:groupId/databaseUsersReturns all database users that belong to the specified project. - POSTCreate One Database User in One Project
/api/atlas/v2/groups/:groupId/databaseUsersCreates one database user in the specified project. This MongoDB Cloud supports a default limit of 100 and a maximum of 900 database users per project. If you… - GETReturn One Database User from One Project
/api/atlas/v2/groups/:groupId/databaseUsers/:databaseName/:usernameReturns one database user that belong to the specified project. - DELETERemove One Database User from One Project
/api/atlas/v2/groups/:groupId/databaseUsers/:databaseName/:usernameRemoves one database user from the specified project. - PATCHUpdate One Database User in One Project
/api/atlas/v2/groups/:groupId/databaseUsers/:databaseName/:usernameUpdates one database user that belongs to the specified project.
Encryption at Rest using Customer Key Management
- GETReturn One Configuration for Encryption at Rest Using Customer-Managed Keys for One Project
/api/atlas/v2/groups/:groupId/encryptionAtRestReturns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't… - PATCHUpdate Encryption at Rest Configuration in One Project
/api/atlas/v2/groups/:groupId/encryptionAtRestUpdates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't… - GETReturn Private Endpoints for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project
/api/atlas/v2/groups/:groupId/encryptionAtRest/:cloudProvider/privateEndpointsReturns the private endpoints of the specified cloud provider for encryption at rest using customer key management. - POSTCreate One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project
/api/atlas/v2/groups/:groupId/encryptionAtRest/:cloudProvider/privateEndpointsCreates a private endpoint in the specified region for encryption at rest using customer key management. - GETReturn One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project
/api/atlas/v2/groups/:groupId/encryptionAtRest/:cloudProvider/privateEndpoints/:endpointIdReturns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - DELETEDelete One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider from One Project
/api/atlas/v2/groups/:groupId/encryptionAtRest/:cloudProvider/privateEndpoints/:endpointIdDeletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management.
Events
- GETReturn All Event Types
/api/atlas/v2/eventTypesReturns a list of all event types, along with a description and additional metadata about each event. - GETReturn Events from One Project
/api/atlas/v2/groups/:groupId/eventsReturns events for the specified project. Events identify significant database, billing, or security activities or status changes. This resource remains under… - GETReturn One Event from One Project
/api/atlas/v2/groups/:groupId/events/:eventIdReturns one event for the specified project. Events identify significant database, billing, or security activities or status changes. Use the Return Events… - GETReturn Events from One Organization
/api/atlas/v2/orgs/:orgId/eventsReturns events for the specified organization. Events identify significant database, billing, or security activities or status changes. This resource remains… - GETReturn One Event from One Organization
/api/atlas/v2/orgs/:orgId/events/:eventIdReturns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. Use the Return…
Federated Authentication
- DELETEDelete One Federation Settings Instance
/api/atlas/v2/federationSettings/:federationSettingsIdDeletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting Service… - GETReturn All Organization Configurations from One Federation
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigsReturns all connected organization configurations in the specified federation. To use this resource, the requesting Service Account or API Key must have the… - GETReturn One Organization Configuration from One Federation
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgIdReturns the specified connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must… - DELETERemove One Organization Configuration from One Federation
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgIdRemoves one connected organization configuration from the specified federation. Note: This request fails if only one connected organization exists in the… - PATCHUpdate One Organization Configuration in One Federation
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgIdUpdates one connected organization configuration from the specified federation. Note If the organization configuration has no associated identity provider,… - GETReturn All Role Mappings from One Organization
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappingsReturns all role mappings from the specified organization in the specified federation. - POSTCreate One Role Mapping in One Organization Configuration
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappingsAdds one role mapping to the specified organization in the specified federation. - GETReturn One Role Mapping from One Organization
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings/:idReturns one role mapping from the specified organization in the specified federation. - PUTUpdate One Role Mapping in One Organization
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings/:idUpdates one role mapping in the specified organization in the specified federation. - DELETERemove One Role Mapping from One Organization
/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings/:idRemoves one role mapping in the specified organization from the specified federation. - GETReturn All Identity Providers in One Federation
/api/atlas/v2/federationSettings/:federationSettingsId/identityProvidersReturns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will… - POSTCreate One Identity Provider
/api/atlas/v2/federationSettings/:federationSettingsId/identityProvidersCreates one identity provider within the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization… - GETReturn One Identity Provider by ID
/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderIdReturns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting Service Account or API Key must… - DELETEDelete One Identity Provider
/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderIdDeletes one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner… - PATCHUpdate One Identity Provider
/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderIdUpdates one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner… - DELETERevoke JWKS from One OIDC Identity Provider
/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderId/jwksRevokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting Service Account or API Key must have the Organization… - GETReturn Metadata of One Identity Provider
/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderId/metadata.xmlReturns the metadata of one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the… - GETReturn Federation Settings for One Organization
/api/atlas/v2/orgs/:orgId/federationSettingsReturns information about the federation settings for the specified organization.
Flex Clusters
- GETReturn All Flex Clusters from One Project
/api/atlas/v2/groups/:groupId/flexClustersReturns details for all flex clusters in the specified project. - POSTCreate One Flex Cluster in One Project
/api/atlas/v2/groups/:groupId/flexClustersCreates one flex cluster in the specified project. - GETReturn One Flex Cluster from One Project
/api/atlas/v2/groups/:groupId/flexClusters/:nameReturns details for one flex cluster in the specified project. - DELETERemove One Flex Cluster from One Project
/api/atlas/v2/groups/:groupId/flexClusters/:nameRemoves one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. - PATCHUpdate One Flex Cluster in One Project
/api/atlas/v2/groups/:groupId/flexClusters/:nameUpdates one flex cluster in the specified project. - POSTUpgrade One Flex Cluster
/api/atlas/v2/groups/:groupId/flexClusters:tenantUpgradeUpgrades a flex cluster to a dedicated cluster (M10+) in the specified project.
Flex Restore Jobs
- GETReturn All Restore Jobs for One Flex Cluster
/api/atlas/v2/groups/:groupId/flexClusters/:name/backup/restoreJobsReturns all restore jobs for one flex cluster from the specified project. - POSTCreate One Restore Job for One Flex Cluster
/api/atlas/v2/groups/:groupId/flexClusters/:name/backup/restoreJobsRestores one snapshot of one flex cluster from the specified project. - GETReturn One Restore Job for One Flex Cluster
/api/atlas/v2/groups/:groupId/flexClusters/:name/backup/restoreJobs/:restoreJobIdReturns one restore job for one flex cluster from the specified project.
Flex Snapshots
- POSTDownload One Flex Cluster Snapshot
/api/atlas/v2/groups/:groupId/flexClusters/:name/backup/downloadRequests one snapshot for the specified flex cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains… - GETReturn All Snapshots for One Flex Cluster
/api/atlas/v2/groups/:groupId/flexClusters/:name/backup/snapshotsReturns all snapshots of one flex cluster from the specified project. - GETReturn One Snapshot for One Flex Cluster
/api/atlas/v2/groups/:groupId/flexClusters/:name/backup/snapshots/:snapshotIdReturns one snapshot of one flex cluster from the specified project.
Global Clusters
- GETReturn One Managed Namespace in One Global Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/globalWritesReturns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and… - POSTAdd One Custom Zone Mapping to One Global Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/globalWrites/customZoneMappingCreates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster.… - DELETERemove All Custom Zone Mappings from One Global Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/globalWrites/customZoneMappingRemoves all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global… - POSTCreate One Managed Namespace in One Global Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/globalWrites/managedNamespacesCreates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and… - DELETERemove One Managed Namespace from One Global Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/globalWrites/managedNamespacesRemoves one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and…
Invoices
- GETReturn Associated Invoices
/api/atlas/v2/orgs/:orgId/associatedInvoicesReturns a list of invoice IDs for the specified organization and month/year. Optionally includes invoices from linked organizations. - POSTCreate One Cost Explorer Query Process
/api/atlas/v2/orgs/:orgId/billing/costExplorer/usageCreates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually… - GETReturn Usage Details for One Cost Explorer Query
/api/atlas/v2/orgs/:orgId/billing/costExplorer/usage/:tokenReturns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing'… - GETReturn All Invoices for One Organization
/api/atlas/v2/orgs/:orgId/invoicesReturns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. If you have a… - GETReturn One Invoice for One Organization
/api/atlas/v2/orgs/:orgId/invoices/:invoiceIdReturns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive… - GETReturn One Invoice as CSV for One Organization
/api/atlas/v2/orgs/:orgId/invoices/:invoiceId/csvReturns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. If you have… - GETReturn All Line Items for One Invoice by Invoice ID
/api/atlas/v2/orgs/:orgId/invoices/:invoiceId/lineItems:searchQuery the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. - GETReturn All Invoice Reports for One Invoice
/api/atlas/v2/orgs/:orgId/invoices/:invoiceId/reportsReturns all unexpired reports for the specified invoice, newest first. Listed reports never include a download URL; retrieve a single report to obtain one. - POSTCreate One Invoice Report
/api/atlas/v2/orgs/:orgId/invoices/:invoiceId/reportsRequests asynchronous generation of a report for the specified invoice. Returns a report identifier that can be used to poll the report status. - GETReturn One Invoice Report
/api/atlas/v2/orgs/:orgId/invoices/:invoiceId/reports/:reportIdReturns the status and details of a previously requested invoice report. - GETReturn All Pending Invoices for One Organization
/api/atlas/v2/orgs/:orgId/invoices/pendingReturns all invoices accruing charges for the current billing cycle for the specified organization. If you have a cross-organization setup, you can view… - GETReturn All Stock Keeping Unit Services
/api/atlas/v2/skuServicesReturns all launched SKU services. SKU services are the customer-facing categories that SKUs are grouped under on MongoDB invoices. - GETReturn All Stock Keeping Units
/api/atlas/v2/skusReturns all available SKUs (Stock Keeping Units) that can appear on MongoDB invoices. SKUs represent different products and services offered by MongoDB. - GETReturn One Stock Keeping Unit
/api/atlas/v2/skus/:skuIdReturns details about a single SKU (Stock Keeping Unit) by its identifier. SKUs represent different products and services offered by MongoDB.
LDAP Configuration
- GETReturn LDAP or X.509 Configuration
/api/atlas/v2/groups/:groupId/userSecurityReturns the current LDAP configuration for the specified project. - PATCHUpdate LDAP or X.509 Configuration
/api/atlas/v2/groups/:groupId/userSecurityEdits the LDAP configuration for the specified project. Updating this configuration triggers a rolling restart of the database. - DELETERemove LDAP User to DN Mapping
/api/atlas/v2/groups/:groupId/userSecurity/ldap/userToDNMappingRemoves the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. - POSTVerify LDAP Configuration in One Project
/api/atlas/v2/groups/:groupId/userSecurity/ldap/verifyVerifies the LDAP configuration for the specified project. - GETReturn Status of LDAP Configuration Verification in One Project
/api/atlas/v2/groups/:groupId/userSecurity/ldap/verify/:requestIdReturns the status of one request to verify one LDAP configuration for the specified project.
Legacy Backup
- GETReturn All Legacy Backup Checkpoints
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backupCheckpointsDeprecated. Returns all legacy backup checkpoints for one cluster in the specified project. - GETReturn One Legacy Backup Checkpoint
/api/atlas/v2/groups/:groupId/clusters/:clusterName/backupCheckpoints/:checkpointIdDeprecated. Returns one legacy backup checkpoint for one cluster in the specified project. - GETReturn All Legacy Backup Restore Jobs
/api/atlas/v2/groups/:groupId/clusters/:clusterName/restoreJobsDeprecated. Returns all legacy backup restore jobs for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud… - POSTCreate One Legacy Backup Restore Job
/api/atlas/v2/groups/:groupId/clusters/:clusterName/restoreJobsDeprecated. Restores one legacy backup for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud Backups. When… - GETReturn One Legacy Backup Restore Job
/api/atlas/v2/groups/:groupId/clusters/:clusterName/restoreJobs/:jobIdDeprecated. Returns one legacy backup restore job for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud… - GETReturn One Snapshot Schedule
/api/atlas/v2/groups/:groupId/clusters/:clusterName/snapshotScheduleDeprecated. Returns the snapshot schedule for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud Backups. When… - PATCHUpdate Snapshot Schedule for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/snapshotScheduleDeprecated. Updates the snapshot schedule for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud Backups. When… - GETReturn All Legacy Backup Snapshots
/api/atlas/v2/groups/:groupId/clusters/:clusterName/snapshotsDeprecated. Returns all legacy backup snapshots for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud… - GETReturn One Legacy Backup Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/snapshots/:snapshotIdDeprecated. Returns one legacy backup snapshot for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud Backups.… - DELETERemove One Legacy Backup Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/snapshots/:snapshotIdDeprecated. Removes one legacy backup snapshot for one cluster in the specified project. Effective 23 March 2020, all new clusters can use only Cloud Backups.… - PATCHUpdate Expiration Date for One Legacy Backup Snapshot
/api/atlas/v2/groups/:groupId/clusters/:clusterName/snapshots/:snapshotIdDeprecated. Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. Effective 23 March 2020, all new clusters can…
Maintenance Windows
- GETReturn One Maintenance Window for One Project
/api/atlas/v2/groups/:groupId/maintenanceWindowReturns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance… - DELETEReset One Maintenance Window for One Project
/api/atlas/v2/groups/:groupId/maintenanceWindowResets the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB… - PATCHUpdate One Maintenance Window for One Project
/api/atlas/v2/groups/:groupId/maintenanceWindowUpdates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB… - POSTToggle Automatic Deferral of Maintenance for One Project
/api/atlas/v2/groups/:groupId/maintenanceWindow/autoDeferToggles automatic deferral of the maintenance window for the specified project. When automatic deferral is enabled, all maintenance windows are deferred for… - POSTDefer One Maintenance Window for One Project
/api/atlas/v2/groups/:groupId/maintenanceWindow/deferDefers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB…
Metric Integrations
- GETReturn All Active Metric Integrations
/api/atlas/v2/groups/:groupId/metricIntegrationsReturns all metric integration configurations for the project. Optionally filter by integration type and provider type. - POSTCreate One Metric Integration
/api/atlas/v2/groups/:groupId/metricIntegrationsCreates a new metric integration configuration identified by a unique ID. - GETReturn One Metric Integration
/api/atlas/v2/groups/:groupId/metricIntegrations/:metricIntegrationIdReturns the configuration for one metric integration identified by its unique ID. - PUTUpdate One Metric Integration
/api/atlas/v2/groups/:groupId/metricIntegrations/:metricIntegrationIdUpdates the configuration for one metric integration identified by its unique ID. - DELETERemove One Metric Integration
/api/atlas/v2/groups/:groupId/metricIntegrations/:metricIntegrationIdRemoves the configuration for one metric integration identified by its unique ID.
MongoDB Cloud Users
- GETReturn All MongoDB Cloud Users in One Project
/api/atlas/v2/groups/:groupId/usersReturns details about the pending and active MongoDB Cloud users associated with the specified project. Note: This resource cannot be used to view details… - POSTAdd One MongoDB Cloud User to One Project
/api/atlas/v2/groups/:groupId/usersAdds one MongoDB Cloud user to one project. If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants… - GETReturn One MongoDB Cloud User in One Project
/api/atlas/v2/groups/:groupId/users/:userIdReturns information about the specified MongoDB Cloud user within the context of the specified project. Note: You can only use this resource to fetch… - DELETERemove One MongoDB Cloud User from One Project
/api/atlas/v2/groups/:groupId/users/:userIdRemoves one MongoDB Cloud user from the specified project. You can remove an active user or a user that has not yet accepted the invitation to join the… - POSTAdd One Project Role to One MongoDB Cloud User
/api/atlas/v2/groups/:groupId/users/:userId:addRoleAdds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. Note: This… - POSTRemove One Project Role from One MongoDB Cloud User
/api/atlas/v2/groups/:groupId/users/:userId:removeRoleRemoves one project-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has been invited to join the project. To… - GETReturn All MongoDB Cloud Users Assigned to One Team
/api/atlas/v2/orgs/:orgId/teams/:teamId/usersReturns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. Teams enable you to grant project… - POSTAdd One MongoDB Cloud User to One Team
/api/atlas/v2/orgs/:orgId/teams/:teamId:addUserAdds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. Note: This… - POSTRemove One MongoDB Cloud User from One Team
/api/atlas/v2/orgs/:orgId/teams/:teamId:removeUserRemoves one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. Note:… - GETReturn All MongoDB Cloud Users in One Organization
/api/atlas/v2/orgs/:orgId/usersReturns details about the pending and active MongoDB Cloud users associated with the specified organization. Note: This resource cannot be used to view… - POSTAdd One MongoDB Cloud User to One Organization
/api/atlas/v2/orgs/:orgId/usersInvites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and… - GETReturn One MongoDB Cloud User in One Organization
/api/atlas/v2/orgs/:orgId/users/:userIdReturns information about the specified MongoDB Cloud user within the context of the specified organization. Note: This resource can only be used to fetch… - DELETERemove One MongoDB Cloud User from One Organization
/api/atlas/v2/orgs/:orgId/users/:userIdRemoves one MongoDB Cloud user in the specified organization. You can remove an active user or a user that has not yet accepted the invitation to join the… - PATCHUpdate One MongoDB Cloud User in One Organization
/api/atlas/v2/orgs/:orgId/users/:userIdUpdates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the… - POSTAdd One Organization Role to One MongoDB Cloud User
/api/atlas/v2/orgs/:orgId/users/:userId:addRoleAdds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join… - POSTRemove One Organization Role from One MongoDB Cloud User
/api/atlas/v2/orgs/:orgId/users/:userId:removeRoleRemoves one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation… - POSTCreate One MongoDB Cloud User
/api/atlas/v2/usersDeprecated. Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database… - GETReturn One MongoDB Cloud User by ID
/api/atlas/v2/users/:userIdDeprecated. Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return… - GETReturn One MongoDB Cloud User by Username
/api/atlas/v2/users/byName/:userNameDeprecated. Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API…
Monitoring and Logs
- GETDownload Logs for One Cluster Host in One Project
/api/atlas/v2/groups/:groupId/clusters/:hostName/logs/:logName.gzReturns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit… - GETReturn All Atlas Search Metric Types for One Process
/api/atlas/v2/groups/:groupId/hosts/:processId/fts/metricsReturns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas… - GETReturn Atlas Search Metrics for One Index in One Namespace
/api/atlas/v2/groups/:groupId/hosts/:processId/fts/metrics/indexes/:databaseName/:collectionName/:indexName/measurements?granularity=PT1M&metrics=stringReturns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the… - GETReturn All Atlas Search Index Metrics for One Namespace
/api/atlas/v2/groups/:groupId/hosts/:processId/fts/metrics/indexes/:databaseName/:collectionName/measurements?granularity=PT1M&metrics=stringReturns the Atlas Search index metrics within the specified time range for one namespace in the specified process. - GETReturn Atlas Search Hardware and Status Metrics
/api/atlas/v2/groups/:groupId/hosts/:processId/fts/metrics/measurements?granularity=PT1M&metrics=stringReturns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project… - GETReturn All MongoDB Processes in One Project
/api/atlas/v2/groups/:groupId/processesReturns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. - GETReturn One MongoDB Process by ID
/api/atlas/v2/groups/:groupId/processes/:processIdReturns the processes for the specified host for the specified project. - GETReturn Available Databases for One MongoDB Process
/api/atlas/v2/groups/:groupId/processes/:processId/databasesReturns the list of databases running on the specified host for the specified project. M0 free clusters, M2, M5, serverless, and Flex clusters have some… - GETReturn One Database for One MongoDB Process
/api/atlas/v2/groups/:groupId/processes/:processId/databases/:databaseNameReturns one database running on the specified host for the specified project. - GETReturn Measurements for One Database in One MongoDB Process
/api/atlas/v2/groups/:groupId/processes/:processId/databases/:databaseName/measurements?granularity=PT1MReturns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB… - GETReturn Available Disks for One MongoDB Process
/api/atlas/v2/groups/:groupId/processes/:processId/disksReturns the list of disks or partitions for the specified host for the specified project. - GETReturn Measurements for One Disk
/api/atlas/v2/groups/:groupId/processes/:processId/disks/:partitionNameReturns measurement details for one disk or partition for the specified host for the specified project. - GETReturn Measurements of One Disk for One MongoDB Process
/api/atlas/v2/groups/:groupId/processes/:processId/disks/:partitionName/measurements?granularity=PT1MReturns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following: Throughput of… - GETReturn Measurements for One MongoDB Process
/api/atlas/v2/groups/:groupId/processes/:processId/measurements?granularity=PT1MReturns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:…
Network Peering
- GETReturn All Network Peering Containers in One Project for One Cloud Provider
/api/atlas/v2/groups/:groupId/containers?providerName=AWSReturns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider,… - POSTCreate One Network Peering Container
/api/atlas/v2/groups/:groupId/containersCreates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP… - GETReturn One Network Peering Container
/api/atlas/v2/groups/:groupId/containers/:containerIdReturns details about one network peering container in one specified project. Network peering containers contain network peering connections. - DELETERemove One Network Peering Container
/api/atlas/v2/groups/:groupId/containers/:containerIdRemoves one network peering container in the specified project. - PATCHUpdate One Network Peering Container
/api/atlas/v2/groups/:groupId/containers/:containerIdUpdates the network details and labels of one specified network peering container in the specified project. - GETReturn All Network Peering Containers in One Project
/api/atlas/v2/groups/:groupId/containers/allReturns details about all network peering containers in the specified project. Network peering containers contain network peering connections. - GETReturn All Network Peering Connections in One Project
/api/atlas/v2/groups/:groupId/peersReturns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect… - POSTCreate One Network Peering Connection
/api/atlas/v2/groups/:groupId/peersCreates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same… - GETReturn One Network Peering Connection in One Project
/api/atlas/v2/groups/:groupId/peers/:peerIdReturns details about one specified network peering connection in the specified project. - DELETERemove One Network Peering Connection
/api/atlas/v2/groups/:groupId/peers/:peerIdRemoves one network peering connection in the specified project. If you remove the last network peering connection associated with a project, MongoDB Cloud… - PATCHUpdate One Network Peering Connection
/api/atlas/v2/groups/:groupId/peers/:peerIdUpdates one specified network peering connection in the specified project. - GETVerify Connect via Peering-Only Mode for One Project
/api/atlas/v2/groups/:groupId/privateIpModeDeprecated. Verifies if someone set the specified project to Connect via Peering Only mode. - PATCHDisable Connect via Peering-Only Mode for One Project
/api/atlas/v2/groups/:groupId/privateIpModeDeprecated. Disables Connect via Peering Only mode for the specified project.
Online Archive
- GETReturn All Online Archives for One Cluster
/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchivesReturns details of all online archives. This archive stores data from one cluster within one project. - POSTCreate One Online Archive
/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchivesCreates one online archive. This archive stores data from one cluster within one project. - GETReturn One Online Archive
/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/:archiveIdReturns one online archive for one cluster. This archive stores data from one cluster within one project. - DELETERemove One Online Archive
/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/:archiveIdRemoves one online archive. This archive stores data from one cluster within one project. - PATCHUpdate One Online Archive
/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/:archiveIdUpdates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. - GETDownload Online Archive Query Logs
/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/queryLogs.gzDownloads query logs for the specified online archive. The API does not support direct calls with the json response schema. You must request a gzip response…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://cloud.mongodb.com- Authentication
- HTTP Digest authentication
OAuth 2.0 (client credentials flow) - Operations
- 541 operations on 336 pathsGET 270POST 113DELETE 81PATCH 66PUT 11
53 marked deprecated - Main resources
- Streams 41Cloud Backups 39Projects 23Clusters 22Service Accounts 22Organizations 20MongoDB Cloud Users 19Atlas Search 18Federated Authentication 18Remote MCP Configurations 18
- Response formats
application/vnd.atlas.2023-01-01+jsonapplication/vnd.atlas.2025-03-12+jsonapplication/vnd.atlas.2024-08-05+jsonapplication/vnd.atlas.2024-05-30+json- Description format
- OpenAPI 3.0.1, API version
2.0 - Links
- OpenAPI document · Terms of service
- Listed from
- MongoDB's published OpenAPI description (mongodb/atlas-sdk-go) (Apache-2.0)
How to test the MongoDB Atlas Administration API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the MongoDB Atlas Administration API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Digest authentication. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Return Database Access History for One Cluster by Cluster Name” (GET /api/atlas/v2/groups/:groupId/dbAccessHistory/clusters/:clusterName), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the MongoDB Atlas Administration API?
The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. The Atlas Administration API supports OAuth2 Service… It is listed under Data & analytics and has 541 endpoints.
Who publishes the MongoDB Atlas Administration API?
It is listed from MongoDB's public API description (an OpenAPI document), not published by MongoDB on Swastik Codes. Anyone who controls mongodb.com can claim the profile by adding a DNS TXT record.
What is the base URL of the MongoDB Atlas Administration API?
Requests go to https://cloud.mongodb.com. Endpoint paths are added to this base URL.
How do I authenticate with the MongoDB Atlas Administration API?
It accepts 2 methods: HTTP Digest authentication; OAuth 2.0 (client credentials flow).
How many endpoints does the MongoDB Atlas Administration API have?
541 operations on 336 paths (270 GET, 113 POST, 81 DELETE, 66 PATCH, 11 PUT). The largest groups are Streams, Cloud Backups, Projects, Clusters. This listing's collection holds the first 400.
Is forking the MongoDB Atlas Administration API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.