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

Search in all APIs

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

MongoDB REST APIs hub

Atlas Admin API v2
Atlas Embedding and Reranking API
(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

API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Topics

Introduction
Authentication

Endpoints

Administrator
[Deprecated] API Keys
Applications
[Deprecated] Authentication Providers
Billing
- List group billing usage in a given period GET
- List app billing usage GET
Custom User Data
- Get the Custom User Data Configuration GET
- Configure Custom User Data PATCH
Deployment
[Deprecated] Data API
Dependencies
- List external dependencies GET
Endpoints
Event Subscriptions
Environments
Functions
[Deprecated] GraphQL API
Hosting
Logs
- Retrieve App Services logs GET
Log Forwarding
Metrics
- Retrieve App Services metrics GET
Rules
[Deprecated] Schemas
Secrets
Security
Data Sources & [Deprecated] Services
[Deprecated] Sync
- Get Flexible Sync information GET
- Get Partition-Based Sync information GET
Triggers
[Deprecated] Users
[Deprecated] User Confirmation
Values
[Deprecated] Push Notifications
[Deprecated] Webhooks