General Information
Documentation
Developer Articles & Topics
Community Forums
Blog
University

Platform
AtlasBuild and scale with an AI-ready platform
Platform Services
DatabaseDeploy a multi-cloud database SearchDeliver engaging search experiences Vector SearchDesign intelligent apps with gen AI Stream ProcessingIntegrate MongoDB and Kafka
Self Managed
Enterprise AdvancedRun and manage MongoDB yourself Community EditionDevelop locally with MongoDB
Tools
CompassWork with MongoDB data in a GUI IntegrationsIntegrations with third-party services Relational MigratorMigrate to MongoDB with confidence
View All ProductsExplore our full developer suite
MongoDB 8.0Our fastest version ever
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
Documentation
Atlas DocumentationGet started using Atlas Server DocumentationLearn to use MongoDB Start With GuidesGet step-by-step guidance for key tasks

Tools and ConnectorsLearn how to connect to MongoDB MongoDB DriversUse drivers and libraries for MongoDB
Resources HubGet help building the next big thing with MongoDB
Connect
Developer CenterExplore a wide range of developer resources CommunityJoin a global community of developers Courses and CertificationLearn for free from MongoDB Events and WebinarsFind an event or webinar near you
Use cases
Artificial Intelligence Payments Serverless Development Gaming
Industries
Financial Services Telecommunications Healthcare Retail Public Sector Manufacturing
Solutions LibraryOrganized and tailored solutions to kick-start projects
AI Applications Program
Expedite your AI journey with expert guidance
Learn more
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn more
Customer Case Studies
Hear directly from our users
See Stories
CareersStart your next adventure BlogRead articles and announcements NewsroomRead press releases and news stories
PartnersLearn about our partner ecosystem LeadershipMeet our executive team CompanyLearn more about who we are
Contact Us
Reach out to MongoDB
Let’s chat
Investors
Visit our investor portal
Learn more
Pricing

Support Sign In

Get Started

General Information
Documentation
Developer Articles & Topics
Community Forums
Blog
University

Platform
AtlasBuild and scale with an AI-ready platform
Platform Services
DatabaseDeploy a multi-cloud database SearchDeliver engaging search experiences Vector SearchDesign intelligent apps with gen AI Stream ProcessingIntegrate MongoDB and Kafka
Self Managed
Enterprise AdvancedRun and manage MongoDB yourself Community EditionDevelop locally with MongoDB
Tools
CompassWork with MongoDB data in a GUI IntegrationsIntegrations with third-party services Relational MigratorMigrate to MongoDB with confidence
View All ProductsExplore our full developer suite
MongoDB 8.0Our fastest version ever
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
Documentation
Atlas DocumentationGet started using Atlas Server DocumentationLearn to use MongoDB Start With GuidesGet step-by-step guidance for key tasks

Tools and ConnectorsLearn how to connect to MongoDB MongoDB DriversUse drivers and libraries for MongoDB
Resources HubGet help building the next big thing with MongoDB
Connect
Developer CenterExplore a wide range of developer resources CommunityJoin a global community of developers Courses and CertificationLearn for free from MongoDB Events and WebinarsFind an event or webinar near you
Use cases
Artificial Intelligence Payments Serverless Development Gaming
Industries
Financial Services Telecommunications Healthcare Retail Public Sector Manufacturing
Solutions LibraryOrganized and tailored solutions to kick-start projects
AI Applications Program
Expedite your AI journey with expert guidance
Learn more
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn more
Customer Case Studies
Hear directly from our users
See Stories
CareersStart your next adventure BlogRead articles and announcements NewsroomRead press releases and news stories
PartnersLearn about our partner ecosystem LeadershipMeet our executive team CompanyLearn more about who we are
Contact Us
Reach out to MongoDB
Let’s chat
Investors
Visit our investor portal
Learn more
Pricing

Support Sign In

Get Started

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 Toggle dark mode

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
Alerts
Atlas Search
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
Cloud Migration Service
Cloud Provider Access
Cluster Outage Simulation
Clusters
Custom Database Roles
Data Federation
Data Lake Pipelines
Database Users
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
Events
Federated Authentication
Global Clusters
Invoices
LDAP Configuration
Legacy Backup
Maintenance Windows
MongoDB Cloud Users
Monitoring and Logs
Multi-Cloud Clusters
Network Peering
Online Archive
Organizations
Performance Advisor
Private Endpoint Services
Programmatic API Keys
Project IP Access List
Projects
Rolling Index
- Create One Rolling Index POST
Root
- Return the status of this MongoDB application GET
Serverless Instances
Serverless Private Endpoints
Shared-Tier Restore Jobs
Shared-Tier Snapshots
Teams
Third-Party Integrations
X.509 Authentication

Powered by Bump.sh

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 Toggle dark mode

Cluster Outage Simulation

Returns, starts, or ends a cluster outage simulation.

English
Português
한국어
日本語
简体中文

About

Careers
Investor Relations
Legal
Privacy Policy
GitHub
Security Information
Trust Center
Connect with Us

Support

Contact Us
Customer Portal
Atlas Status
Customer Support

Deployment Options

MongoDB Atlas
Enterprise Advanced
Community Edition

Data Basics

Vector Databases
NoSQL Databases
Document Databases
RAG Database
ACID Transactions
MERN Stack
MEAN Stack