Documentation
General Information
Documentation
Developer Articles & Topics
Community Forums
Blog
University
Products
Platform
Atlas
Build and scale with an AI-ready platform
Platform Services
Database
Deploy a multi-cloud database
Search
Deliver engaging search experiences
Vector Search
Design intelligent apps with gen AI
Stream Processing
Integrate MongoDB and Kafka
Self Managed
Enterprise Advanced
Run and manage MongoDB yourself
Community Edition
Develop locally with MongoDB
Tools
Compass
Work with MongoDB data in a GUI
Integrations
Integrations with third-party services
Relational Migrator
Migrate to MongoDB with confidence
View All Products
Explore our full developer suite
arrow-right
MongoDB 8.0
Our fastest version ever
arrow-right
Build with MongoDB Atlas
Get started for free in minutes
Sign Up
Test Enterprise Advanced
Develop with MongoDB on-premises
Download
Try Community Edition
Explore the latest version of MongoDB
Download
Resources
Documentation
Atlas Documentation
Get started using Atlas
Server Documentation
Learn to use MongoDB
Start With Guides
Get step-by-step guidance for key tasks
Tools and Connectors
Learn how to connect to MongoDB
MongoDB Drivers
Use drivers and libraries for MongoDB
Resources Hub
Get help building the next big thing with MongoDB
arrow-right
Connect
Developer Center
Explore a wide range of developer resources
Community
Join a global community of developers
Courses and Certification
Learn for free from MongoDB
Events and Webinars
Find an event or webinar near you
Solutions
Use cases
Artificial Intelligence
Payments
Serverless Development
Gaming
Industries
Financial Services
Telecommunications
Healthcare
Retail
Public Sector
Manufacturing
Solutions Library
Organized and tailored solutions to kick-start projects
arrow-right
AI Applications Program
Expedite your AI journey with expert guidance
Learn more
arrow-right
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn more
arrow-right
Customer Case Studies
Hear directly from our users
See Stories
arrow-right
Company
Careers
Start your next adventure
Blog
Read articles and announcements
Newsroom
Read press releases and news stories
Partners
Learn about our partner ecosystem
Leadership
Meet our executive team
Company
Learn more about who we are
Contact Us
Reach out to MongoDB
Let’s chat
arrow-right
Investors
Visit our investor portal
Learn more
arrow-right
Pricing
Eng
Support
Sign In
menu-vertical
Get Started
Documentation
General Information
Documentation
Developer Articles & Topics
Community Forums
Blog
University
Products
Platform
Atlas
Build and scale with an AI-ready platform
Platform Services
Database
Deploy a multi-cloud database
Search
Deliver engaging search experiences
Vector Search
Design intelligent apps with gen AI
Stream Processing
Integrate MongoDB and Kafka
Self Managed
Enterprise Advanced
Run and manage MongoDB yourself
Community Edition
Develop locally with MongoDB
Tools
Compass
Work with MongoDB data in a GUI
Integrations
Integrations with third-party services
Relational Migrator
Migrate to MongoDB with confidence
View All Products
Explore our full developer suite
arrow-right
MongoDB 8.0
Our fastest version ever
arrow-right
Build with MongoDB Atlas
Get started for free in minutes
Sign Up
Test Enterprise Advanced
Develop with MongoDB on-premises
Download
Try Community Edition
Explore the latest version of MongoDB
Download
Resources
Documentation
Atlas Documentation
Get started using Atlas
Server Documentation
Learn to use MongoDB
Start With Guides
Get step-by-step guidance for key tasks
Tools and Connectors
Learn how to connect to MongoDB
MongoDB Drivers
Use drivers and libraries for MongoDB
Resources Hub
Get help building the next big thing with MongoDB
arrow-right
Connect
Developer Center
Explore a wide range of developer resources
Community
Join a global community of developers
Courses and Certification
Learn for free from MongoDB
Events and Webinars
Find an event or webinar near you
Solutions
Use cases
Artificial Intelligence
Payments
Serverless Development
Gaming
Industries
Financial Services
Telecommunications
Healthcare
Retail
Public Sector
Manufacturing
Solutions Library
Organized and tailored solutions to kick-start projects
arrow-right
AI Applications Program
Expedite your AI journey with expert guidance
Learn more
arrow-right
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn more
arrow-right
Customer Case Studies
Hear directly from our users
See Stories
arrow-right
Company
Careers
Start your next adventure
Blog
Read articles and announcements
Newsroom
Read press releases and news stories
Partners
Learn about our partner ecosystem
Leadership
Meet our executive team
Company
Learn more about who we are
Contact Us
Reach out to MongoDB
Let’s chat
arrow-right
Investors
Visit our investor portal
Learn more
arrow-right
Pricing
Eng
Support
Sign In
menu-vertical
Get Started
ESC
Example searches: “400”, “API Changelog”, “ipAddress”, “403”, “Back to Atlas Docs”
Search API documentation…
Ctrl+K
⌘K
MongoDB REST APIs hub
Atlas Admin API v2
(Deprecated) Atlas Admin API v1
(Deprecated) MongoDB Atlas Data API v1
MongoDB Atlas App Services Admin API 3.0
MongoDB Atlas Status API
MongoDB Relational Migrator REST API
Back to hub page
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Back to Atlas Docs
API Changelog
Toggle dark mode
2023-11-15
latest
default
2023-01-01
2023-02-01
2023-10-01
2023-11-15
2024-05-30
2024-08-05
2024-10-23
2024-11-13
2025-02-19
2025-03-12
Topics
Introduction
Authentication
Endpoints
Access Tracking
Return Database Access History for One Cluster by Cluster Name
GET
Return Database Access History for One Cluster by Hostname
GET
Alert Configurations
Return All Alert Configuration Matchers Field Names
GET
Return All Alert Configurations in One Project
GET
Create One Alert Configuration in One Project
POST
Return One Alert Configuration from One Project
GET
Update One Alert Configuration in One Project
PUT
Remove One Alert Configuration from One Project
DELETE
Toggle State of One Alert Configuration in One Project
PATCH
Return All Alert Configurations Set for One Alert
GET
Alerts
Return All Open Alerts for One Alert Configuration
GET
Return All Alerts from One Project
GET
Return One Alert from One Project
GET
Acknowledge One Alert from One Project
PATCH
Atlas Search
Create One Atlas Search Index
POST
Return All Atlas Search Indexes for One Collection
GET
Return One Atlas Search Index
GET
Remove One Atlas Search Index
DELETE
Update One Atlas Search Index
PATCH
Return All Search Nodes
GET
Create Search Nodes
POST
Delete Search Nodes
DELETE
Update Search Nodes
PATCH
Auditing
Return Auditing Configuration for One Project
GET
Update Auditing Configuration for One Project
PATCH
AWS Clusters DNS
Return One Custom DNS Configuration for Atlas Clusters on AWS
GET
Update State of One Custom DNS Configuration for Atlas Clusters on AWS
PATCH
Cloud Backups
Return All Snapshot Export Buckets
GET
Create One Snapshot Export Bucket
POST
Return One Snapshot Export Bucket
GET
Delete One Snapshot Export Bucket
DELETE
Return Backup Compliance Policy Settings
GET
Update Backup Compliance Policy Settings
PUT
Return All Snapshot Export Jobs
GET
Create One Snapshot Export Job
POST
Return One Snapshot Export Job
GET
Return All Restore Jobs for One Cluster
GET
Restore One Snapshot of One Cluster
POST
Return One Restore Job for One Cluster
GET
Cancel One Restore Job for One Cluster
DELETE
Return One Cloud Backup Schedule
GET
Remove All Cloud Backup Schedules
DELETE
Update Cloud Backup Schedule for One Cluster
PATCH
Return All Replica Set Cloud Backups
GET
Take One On-Demand Snapshot
POST
Return One Sharded Cluster Cloud Backup
GET
Remove One Sharded Cluster Cloud Backup
DELETE
Return All Sharded Cluster Cloud Backups
GET
Return One Replica Set Cloud Backup
GET
Remove One Replica Set Cloud Backup
DELETE
Update Expiration Date for One Cloud Backup
PATCH
Return All Restore Jobs for One Serverless Instance
GET
Restore One Snapshot of One Serverless Instance
POST
Return One Restore Job for One Serverless Instance
GET
Return All Snapshots of One Serverless Instance
GET
Return One Snapshot of One Serverless Instance
GET
Cloud Migration Service
Migrate One Local Managed Cluster to MongoDB Atlas
POST
Validate One Migration Request
POST
Return One Migration Validation Job
GET
Return One Migration Job
GET
Cut Over One Migrated Cluster
PUT
Return All Projects Available for Migration
GET
Create One Link-Token
POST
Remove One Link-Token
DELETE
Cloud Provider Access
Return All Cloud Provider Access Roles
GET
Create One Cloud Provider Access Role
POST
Deauthorize One Cloud Provider Access Role
DELETE
Return One Cloud Provider Access Role
GET
Authorize One Cloud Provider Access Role
PATCH
Cluster Outage Simulation
Return One Outage Simulation
GET
Start One Outage Simulation
POST
End One Outage Simulation
DELETE
Clusters
Return All Authorized Clusters in All Projects
GET
Return All Clusters in One Project
GET
Create One Cluster in One Project
POST
Return All Cloud Provider Regions
GET
Upgrade One Shared-Tier Cluster
POST
Upgrade One Shared-Tier Cluster to One Serverless Instance
POST
Return One Cluster from One Project
GET
Remove One Cluster from One Project
DELETE
Update One Cluster in One Project
PATCH
Return Advanced Configuration Options for One Cluster
GET
Update Advanced Configuration Options for One Cluster
PATCH
Test Failover for One Cluster
POST
Return Status of All Cluster Operations
GET
Load Sample Dataset into One Cluster
POST
Return Status of Sample Dataset Load for One Cluster
GET
Collection Level Metrics
Return Pinned Namespaces
GET
Pin Namespaces
PUT
Add Pinned Namespaces
PATCH
Unpin namespaces
PATCH
Return Ranked Namespaces from a Cluster
GET
Return Cluster-Level Query Latency
GET
Return all metric names
GET
Return Ranked Namespaces from a Host
GET
Return Host-Level Query Latency
GET
Custom Database Roles
Return All Custom Roles in One Project
GET
Create One Custom Role
POST
Return One Custom Role in One Project
GET
Remove One Custom Role from One Project
DELETE
Update One Custom Role in One Project
PATCH
Data Federation
Return All Federated Database Instances in One Project
GET
Create One Federated Database Instance in One Project
POST
Return One Federated Database Instance in One Project
GET
Remove One Federated Database Instance from One Project
DELETE
Update One Federated Database Instance in One Project
PATCH
Return All Query Limits for One Federated Database Instance
GET
Return One Federated Database Instance Query Limit for One Project
GET
Delete One Query Limit for One Federated Database Instance
DELETE
Configure One Query Limit for One Federated Database Instance
PATCH
Download Query Logs for One Federated Database Instance
GET
Return All Federated Database Instance and Online Archive Private Endpoints in One Project
GET
Create One Federated Database Instance and Online Archive Private Endpoint for One Project
POST
Return One Federated Database Instance and Online Archive Private Endpoint in One Project
GET
Remove One Federated Database Instance and Online Archive Private Endpoint from One Project
DELETE
Data Lake Pipelines
Return All Data Lake Pipelines in One Project
GET
Create One Data Lake Pipeline
POST
Return One Data Lake Pipeline
GET
Remove One Data Lake Pipeline
DELETE
Update One Data Lake Pipeline
PATCH
Return All Ingestion Schedules for One Data Lake Pipeline
GET
Return All Backup Snapshots for One Data Lake Pipeline
GET
Pause One Data Lake Pipeline
POST
Resume One Data Lake Pipeline
POST
Return All Data Lake Pipeline Runs in One Project
GET
Return One Data Lake Pipeline Run
GET
Delete One Pipeline Run Dataset
DELETE
Trigger On-Demand Snapshot Ingestion
POST
Database Users
Return All Database Users in One Project
GET
Create One Database User in One Project
POST
Return One Database User from One Project
GET
Remove One Database User from One Project
DELETE
Update One Database User in One Project
PATCH
Encryption at Rest using Customer Key Management
Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project
GET
Update Encryption at Rest Configuration for One Project
PATCH
Return Private Endpoints of a Cloud Provider for Encryption at Rest Using Customer Key Management for One Project
GET
Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management
POST
Return One Private Endpoint for Encryption at Rest Using Customer Key Management
GET
Delete One Private Endpoint for Encryption at Rest Using Customer Key Management
DELETE
Events
Return All Event Types
GET
Return Events from One Project
GET
Return One Event from One Project
GET
Return Events from One Organization
GET
Return One Event from One Organization
GET
Federated Authentication
Delete One Federation Settings Instance
DELETE
Return All Organization Configurations from One Federation
GET
Return One Organization Configuration from One Federation
GET
Remove One Organization Configuration from One Federation
DELETE
Update One Organization Configuration in One Federation
PATCH
Return All Role Mappings from One Organization
GET
Create One Role Mapping in One Organization Configuration
POST
Return One Role Mapping from One Organization
GET
Update One Role Mapping in One Organization
PUT
Remove One Role Mapping from One Organization
DELETE
Return All Identity Providers in One Federation
GET
Create One Identity Provider
POST
Return One Identity Provider by ID
GET
Delete One Identity Provider
DELETE
Update One Identity Provider
PATCH
Revoke JWKS from One OIDC Identity Provider
DELETE
Return Metadata of One Identity Provider
GET
Return Federation Settings for One Organization
GET
Global Clusters
Return One Managed Namespace in One Global Cluster
GET
Add One Custom Zone Mapping to One Global Cluster
POST
Remove All Custom Zone Mappings from One Global Cluster
DELETE
Create One Managed Namespace in One Global Cluster
POST
Remove One Managed Namespace from One Global Cluster
DELETE
Invoices
Create One Cost Explorer Query Process
POST
Return results from a given Cost Explorer query, or notify that the results are not ready yet.
GET
Return All Invoices for One Organization
GET
Return All Pending Invoices for One Organization
GET
Return One Invoice for One Organization
GET
Return One Invoice as CSV for One Organization
GET
LDAP Configuration
Return LDAP or X.509 Configuration
GET
Update LDAP or X.509 Configuration
PATCH
Remove LDAP User to DN Mapping
DELETE
Verify LDAP Configuration in One Project
POST
Return Status of LDAP Configuration Verification in One Project
GET
Legacy Backup
Return All Legacy Backup Checkpoints
GET
Return One Legacy Backup Checkpoint
GET
Return All Legacy Backup Restore Jobs
GET
Create One Legacy Backup Restore Job
POST
Return One Legacy Backup Restore Job
GET
Return One Snapshot Schedule
GET
Update Snapshot Schedule for One Cluster
PATCH
Return All Legacy Backup Snapshots
GET
Return One Legacy Backup Snapshot
GET
Remove One Legacy Backup Snapshot
DELETE
Update Expiration Date for One Legacy Backup Snapshot
PATCH
Maintenance Windows
Return One Maintenance Window for One Project
GET
Reset One Maintenance Window for One Project
DELETE
Update One Maintenance Window for One Project
PATCH
Toggle Automatic Deferral of Maintenance for One Project
POST
Defer One Maintenance Window for One Project
POST
MongoDB Cloud Users
Return All MongoDB Cloud Users in One Project
GET
Remove One MongoDB Cloud User from One Project
DELETE
Return All MongoDB Cloud Users Assigned to One Team
GET
Return All MongoDB Cloud Users in One Organization
GET
Remove One MongoDB Cloud User from One Organization
DELETE
Create One MongoDB Cloud User
POST
Return One MongoDB Cloud User by Username
GET
Return One MongoDB Cloud User by ID
GET
Monitoring and Logs
Download Logs for One Cluster Host in One Project
GET
Return All Atlas Search Metric Types for One Process
GET
Return All Atlas Search Index Metrics for One Namespace
GET
Return Atlas Search Metrics for One Index in One Namespace
GET
Return Atlas Search Hardware and Status Metrics
GET
Return All MongoDB Processes in One Project
GET
Return One MongoDB Process by ID
GET
Return Available Databases for One MongoDB Process
GET
Return One Database for One MongoDB Process
GET
Return Measurements for One Database in One MongoDB Process
GET
Return Available Disks for One MongoDB Process
GET
Return Measurements for One Disk
GET
Return Measurements of One Disk for One MongoDB Process
GET
Return Measurements for One MongoDB Process
GET
Network Peering
Return All Network Peering Containers in One Project for One Cloud Provider
GET
Create One Network Peering Container
POST
Return All Network Peering Containers in One Project
GET
Return One Network Peering Container
GET
Remove One Network Peering Container
DELETE
Update One Network Peering Container
PATCH
Return All Network Peering Connections in One Project
GET
Create One Network Peering Connection
POST
Return One Network Peering Connection in One Project
GET
Remove One Network Peering Connection
DELETE
Update One Network Peering Connection
PATCH
Verify Connect via Peering-Only Mode for One Project
GET
Disable Connect via Peering-Only Mode for One Project
PATCH
Online Archive
Return All Online Archives for One Cluster
GET
Create One Online Archive
POST
Download Online Archive Query Logs
GET
Return One Online Archive
GET
Remove One Online Archive
DELETE
Update One Online Archive
PATCH
Organizations
Return All Organizations
GET
Create One Organization
POST
Return One Organization
GET
Remove One Organization
DELETE
Update One Organization
PATCH
Return All Projects in One Organization
GET
Return All Organization Invitations
GET
Invite One MongoDB Cloud User to One Atlas Organization
POST
Update One Organization Invitation
PATCH
Return One Organization Invitation
GET
Remove One Organization Invitation
DELETE
Update One Organization Invitation by Invitation ID
PATCH
Return Settings for One Organization
GET
Update Settings for One Organization
PATCH
Update Organization Roles for One MongoDB Cloud User
PUT
Performance Advisor
Return Managed Slow Operation Threshold Status
GET
Disable Managed Slow Operation Threshold
DELETE
Enable Managed Slow Operation Threshold
POST
Return All Namespaces for One Host
GET
Return Slow Queries
GET
Return All Suggested Indexes
GET
Return Serverless Auto-Indexing Status
GET
Set Serverless Auto-Indexing Status
POST
Private Endpoint Services
Create One Private Endpoint Service for One Provider
POST
Return Regionalized Private Endpoint Status
GET
Toggle Regionalized Private Endpoint Status
PATCH
Return All Private Endpoint Services for One Provider
GET
Return One Private Endpoint Service for One Provider
GET
Remove One Private Endpoint Service for One Provider
DELETE
Create One Private Endpoint for One Provider
POST
Return One Private Endpoint for One Provider
GET
Remove One Private Endpoint for One Provider
DELETE
Programmatic API Keys
Return All Organization API Keys Assigned to One Project
GET
Create and Assign One Organization API Key to One Project
POST
Assign One Organization API Key to One Project
POST
Unassign One Organization API Key from One Project
DELETE
Update Organization API Key Roles for One Project
PATCH
Return All Organization API Keys
GET
Create One Organization API Key
POST
Return One Organization API Key
GET
Remove One Organization API Key
DELETE
Update One Organization API Key
PATCH
Return All Access List Entries for One Organization API Key
GET
Create One Access List Entry for One Organization API Key
POST
Return One Access List Entry for One Organization API Key
GET
Remove One Access List Entry for One Organization API Key
DELETE
Project IP Access List
Return All Project IP Access List Entries
GET
Add Entries to Project IP Access List
POST
Return One Project IP Access List Entry
GET
Remove One Entry from One Project IP Access List
DELETE
Return Status of One Project IP Access List Entry
GET
Projects
Return All Projects
GET
Create One Project
POST
Return One Project by Name
GET
Return One Project
GET
Remove One Project
DELETE
Update One Project
PATCH
Add One MongoDB Cloud User to One Project
POST
Return All Project Invitations
GET
Invite One MongoDB Cloud User to One Project
POST
Update One Project Invitation
PATCH
Return One Project Invitation
GET
Remove One Project Invitation
DELETE
Update One Project Invitation by Invitation ID
PATCH
Return All IP Addresses for One Project
GET
Return All Limits for One Project
GET
Return One Limit for One Project
GET
Remove One Project Limit
DELETE
Set One Project Limit
PATCH
Return All Available MongoDB LTS Versions for Clusters in One Project
GET
Return Project Settings
GET
Update Project Settings
PATCH
Update Project Roles for One MongoDB Cloud User
PUT
Push-Based Log Export
Return Push-Based Log Export Configuration for One Project
GET
Enable Push-Based Log Export for One Project
POST
Disable Push-Based Log Export for One Project
DELETE
Update Push-Based Log Export for One Project
PATCH
Rolling Index
Create One Rolling Index
POST
Root
Return the status of this MongoDB application
GET
Return All Control Plane IP Addresses
GET
Serverless Instances
Return All Serverless Instances in One Project
GET
Create One Serverless Instance in One Project
POST
Return One Serverless Instance from One Project
GET
Remove One Serverless Instance from One Project
DELETE
Update One Serverless Instance in One Project
PATCH
Serverless Private Endpoints
Return All Private Endpoints for One Serverless Instance
GET
Create One Private Endpoint for One Serverless Instance
POST
Return One Private Endpoint for One Serverless Instance
GET
Remove One Private Endpoint for One Serverless Instance
DELETE
Update One Private Endpoint for One Serverless Instance
PATCH
Shared-Tier Restore Jobs
Create One Restore Job for One M2 or M5 Cluster
POST
Return All Restore Jobs for One M2 or M5 Cluster
GET
Return One Restore Job for One M2 or M5 Cluster
GET
Shared-Tier Snapshots
Download One M2 or M5 Cluster Snapshot
POST
Return All Snapshots for One M2 or M5 Cluster
GET
Return One Snapshot of One M2 or M5 Cluster
GET
Streams
Return All Stream Instances in One Project
GET
Create One Stream Instance
POST
Return All Private Link Connections
GET
Create One Private Link Connection
POST
Return One Private Link Connection
GET
Delete One Private Link Connection
DELETE
Return All VPC Peering Connections
GET
Delete One VPC Peering Connection
DELETE
Accept One Incoming VPC Peering Connection
POST
Reject One Incoming VPC Peering Connection
POST
Return One Stream Instance
GET
Delete One Stream Instance
DELETE
Update One Stream Instance
PATCH
Download Audit Logs for One Atlas Stream Processing Instance
GET
Return All Connections of the Stream Instances
GET
Create One Stream Connection
POST
Return One Stream Connection
GET
Delete One Stream Connection
DELETE
Update One Stream Connection
PATCH
Teams
Return All Teams in One Project
GET
Add One Team to One Project
POST
Return One Team in One Project
GET
Remove One Team from One Project
DELETE
Update Team Roles in One Project
PATCH
Return All Teams in One Organization
GET
Create One Team in One Organization
POST
Return One Team by Name
GET
Return One Team by ID
GET
Remove One Team from One Organization
DELETE
Rename One Team
PATCH
Assign MongoDB Cloud Users in One Organization to One Team
POST
Remove One MongoDB Cloud User from One Team
DELETE
Third-Party Integrations
Return All Active Third-Party Service Integrations
GET
Return One Third-Party Service Integration
GET
Update One Third-Party Service Integration
PUT
Configure One Third-Party Service Integration
POST
Remove One Third-Party Service Integration
DELETE
X.509 Authentication
Return All X.509 Certificates Assigned to One Database User
GET
Create One X.509 Certificate for One Database User
POST
Disable Customer-Managed X.509
DELETE
Search API documentation…
Ctrl+K
⌘K
MongoDB REST APIs hub
Atlas Admin API v2
(Deprecated) Atlas Admin API v1
(Deprecated) MongoDB Atlas Data API v1
MongoDB Atlas App Services Admin API 3.0
MongoDB Atlas Status API
MongoDB Relational Migrator REST API
Back to hub page
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Back to Atlas Docs
API Changelog
Toggle dark mode
Dismiss highlight
Show more
Invoices
Returns invoices.
