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: “apikeys”, “device_id”, “user_id”, “apiKey”, “error”
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
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Topics
Introduction
Authentication
Endpoints
Administrator
List App Services Admin Auth Providers
GET
Authenticate as an App Services administrator
POST
Get information about the currently logged in user
GET
Obtain a session access token
POST
Delete a session access token
DELETE
[Deprecated] API Keys
List API keys
GET
Create a new API key
POST
Retrieve information about an API key
GET
Delete an API key
DELETE
Enable an API key
PUT
Disable an API key
PUT
Applications
List all App Services Apps in an Atlas project/group
GET
Create a new app
POST
Get an app
GET
Delete an app
DELETE
Export an app as a zip file
GET
Pull App Configuration Files
GET
Push App Configuration Files
PATCH
[Deprecated] Authentication Providers
List authentication providers in a Atlas App Services App
GET
Create an authentication provider
POST
Retrieve information about authentication provider
GET
Delete an authentication provider
DELETE
Update an authentication provider
PATCH
Disable an authentication provider
PUT
Enable an authentication provider
PUT
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
List all available Atlas App cloud regions
GET
Get the Deployment Configuration
GET
Configure Deployment
PATCH
List recent deployments
GET
Get a deployment
GET
Redeploy a Deployment
POST
Get Current Deployment Draft
GET
Create a Deployment Draft
POST
Discard the specified deployment draft
DELETE
Deploy a deployment draft
POST
Diff a draft with the current deployment
GET
Get a Deployment Migration
GET
Create a Deployment Migration
PUT
[Deprecated] Data API
Get the Data API Configuration
GET
Enable the Data API
POST
Modify the Data API
PATCH
List Data API versions
GET
Dependencies
List external dependencies
GET
Endpoints
Get all endpoints
GET
Create an endpoint
POST
Get an endpoint
GET
Modify an endpoint
PUT
Delete an endpoint
DELETE
Event Subscriptions
List Event Subscriptions
GET
Get an Event Subscription
GET
Get the Latest Event Subscription Execution
GET
Environments
Set the App Environment
PUT
List All Environment Values
GET
Create an Environment Value
POST
Get an Environment Value
GET
Modify an Environment Value
PUT
Delete an Environment Value
DELETE
Functions
Execute a function
POST
Execute a function's source code for testing
POST
List Functions
GET
Create a new Function
POST
Retrieve a Function
GET
Update a Function
PUT
Delete a Function
DELETE
[Deprecated] GraphQL API
Run a query or mutation
POST
Get GraphQL API Configuration
GET
Update GraphQL API Configuration
PUT
Get all custom resolvers
GET
Create a custom resolver
POST
Get a custom resolver
GET
Modify a custom resolver
PUT
Delete a custom resolver
DELETE
Get validation settings
GET
Modify validation settings
PUT
Hosting
Get Hosting Configuration
GET
Enable/Disable Hosting
PATCH
List all hosted assets
GET
Move or copy a hosted asset
POST
Retrieve metadata for a specific hosted asset
GET
Upload or replace a hosted asset
PUT
Update the metadata attributes of a hosted asset
PATCH
Logs
Retrieve App Services logs
GET
Log Forwarding
List log forwarders.
GET
Create a log forwarder.
POST
Get a specific log forwarder.
GET
Delete a log forwarder.
DELETE
Update a log forwarder.
PATCH
Enable a log forwarder.
PUT
Disable a log forwarder.
PUT
Metrics
Retrieve App Services metrics
GET
Rules
Get all rules
GET
Create a rule
POST
Get a rule
GET
Update a rule
PUT
Delete a rule
DELETE
Get default roles and filters
GET
Update default roles and filters
PUT
Create default roles and filters
POST
Delete default roles and filters
DELETE
[Deprecated] Schemas
Sample & Validate Documents
POST
List schemas
GET
Create a schema
POST
Get a schema
GET
Update a schema
PUT
Delete a schema
DELETE
Get Null Type Schema Validation Setting
GET
Set Null Type Schema Validation Setting
PUT
Secrets
List secrets
GET
Create a new Secret
POST
Modify a Secret
PUT
Delete a Secret
DELETE
Security
List allowed HTTP origins
GET
Set allowed HTTP origins
POST
List the allowed entries in the Access List
GET
Create an IP address or CIDR block in the Access List
POST
Delete an IP address or CIDR block from the Access List
DELETE
Modify an IP address or CIDR block in the Access List
PATCH
List VPC Private Endpoints
GET
Create a VPC Private Endpoint
POST
Get a VPC Private Endpoint
GET
Modify a VPC Private Endpoint
PUT
Delete a VPC Private Endpoint
DELETE
List VPC Private Endpoint Services
GET
Toggle Non-VPC Requests
POST
Get User Refresh Token Expiration Time
GET
Set User Refresh Token Expiration Time
PUT
Data Sources & [Deprecated] Services
Link multiple data sources
POST
List all data sources and third-party services
GET
Create a data source or third-party service
POST
Get a data source or third-party service
GET
Delete a data source or third-party service
DELETE
Update a service
PATCH
Run a command associated with a service
POST
Get information about the underlying Atlas mongod
GET
Get a Service Configuration
GET
Update a Service Configuration
PATCH
Generate a JSON schema from sample
POST
[Deprecated] Sync
Get Flexible Sync information
GET
Get Partition-Based Sync information
GET
Triggers
Get all triggers
GET
Create a trigger
POST
Get a trigger
GET
Update a trigger
PUT
Delete a trigger
DELETE
Resume a suspended trigger
PUT
[Deprecated] Users
List users
GET
Create a user
POST
Verify & decode an access token
POST
Get a User
GET
Delete a user
DELETE
Change a user's email
PATCH
List a user's devices
GET
Revoke user sessions
PUT
Enable a user
PUT
Disable a user
PUT
List pending users
GET
Delete a pending email/password authentication user
DELETE
[Deprecated] User Confirmation
Send a confirmation email
POST
Confirm a pending user
POST
Rerun a user confirmation workflow
POST
Values
List all values defined in an application.
GET
Define a Value in an application
POST
Retrieve a value definition from an application
GET
Update a value definition in an application
PUT
Delete a value defined in an application.
DELETE
[Deprecated] Push Notifications
List push notifications
GET
Create a push notification
POST
Retrieve a push notification message
GET
Update a push notification
PUT
Delete a push notification message
DELETE
Set a push notification's type
PUT
Send a push notification
POST
[Deprecated] Webhooks
List webhooks
GET
Create a webhook
POST
Retrieve a webhook
GET
Update a webhook
PUT
Delete a webhook
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
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Dismiss highlight
Show more
Custom User Data
Configure
custom user data
.
