Home
Providers
MongoDB
MongoDB
MongoDB is a source-available cross-platform document-oriented database program. Classified as a NoSQL database, MongoDB uses JSON-like documents with optional schemas.
MongoDB publishes 51 APIs on the APIs.io network, including Access Tracking API, Activity Feed API, Alert Configurations API, and 48 more. Tagged areas include Cloud Database, Database, Document Database, and NoSQL.
MongoDB’s developer surface includes authentication, getting-started guide, engineering blog, support, developer portal, and 14 more developer resources.
53 APIs
1 MCP Servers
8 Agent Skills
17 Features
Cloud Database Database Document Database NoSQL
On this page
Kin Score
APIs 53
MCP Servers 1
Agent Skills 8
GraphQL 1
Pricing Plans 1
Rate Limits 1
FinOps 1
Features 17
Security Posture 4
Scopes 1
Agentic Access 1
Resources 19
apis.yml
53 Operational Transparency
Composite quality — 49.0/100 · developing
Contract Quality
13.6 / 25
Developer Ergonomics
9.1 / 20
Commercial Clarity
13.7 / 20
Operational Transparency
6.8 / 13
Agent readiness — 52/100 · agent ready
Machine-Readable Contract
18 / 18
Agentic Access Contract
10 / 10
MCP Server
12 / 12
Machine-Readable Auth
10 / 10
Idempotency
0 / 9
Stable Error Semantics
0 / 8
Request/Response Examples
7 / 7
Rate-Limit Signaling
7 / 7
Typed Event Surface
0 / 6
Agent Skills
5 / 5
Well-Known Catalog
0 / 4
Consent & Bot Identity
0 / 3
A2A Agent Card
0 / 8
Dry-Run / Simulate Mode
0 / 4
Individual APIs this provider publishes, each with its own machine-readable definition.
The Atlas Data API lets you read and write data in MongoDB Atlas with standard HTTPS requests, without the need for a MongoDB driver.
Admin API for MongoDB Atlas App Services (formerly Realm), used to manage applications, services, functions, and triggers.
Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner...
Returns pre-filtered activity feed links for projects and organizations. The returned links can be shared and opened to view the activity feed with the specified filters applied.
Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.
Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.
Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.
Returns and edits database auditing settings for MongoDB Cloud projects.
Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use y...
Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.
Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoD...
Returns, adds, authorizes, and removes AWS IAM roles in Atlas.
Returns, starts, or ends a cluster outage simulation.
Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.
Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.
Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. ...
Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.
Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.
Returns, adds, edits, and removes database users.
Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.
Returns events. This collection remains under revision and may change.
Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.
Returns, adds, edits, and removes flex clusters.
Returns and adds restore jobs for flex database deployments.
Returns and requests to download flex database deployment snapshots.
Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you creat...
Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authenticati...
Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.
Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window p...
Returns, adds, and edits MongoDB Cloud users.
Returns database deployment monitoring and logging data.
Returns, adds, edits, and removes network peering containers and peering connections. When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider an...
Returns, adds, edits, or removes an online archive.
Returns, adds, and edits organizational units in MongoDB Cloud.
Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a samp...
Returns, adds, edits, and removes private endpoint services.
Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke us...
Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. U...
Returns, adds, and edits collections of clusters and users in MongoDB Cloud.
You can continually export mongod, mongos, and audit logs to an AWS S3 bucket. The new `/logIntegrations` API provides 1-minute log export on a best-effort basis. The existing `...
The Query Shape Insights API from MongoDB — 4 operation(s) for query shape insights.
Returns details about rate limit policies for the Atlas Administration API.
Configure and manage Atlas Resource Policies within your organization.
Creates one index to a database deployment in a rolling manner. Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an in...
Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.
Returns, adds, edits, and removes serverless instances.
Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.
Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow.
Returns, adds, edits, and removes Streams Workspaces. This resource requires your project ID.
Returns, adds, edits, or removes teams.
Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure. **IMPORTANT**: Each ...
Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources he...
Scroll for all 53
Model Context Protocol servers that expose these APIs to AI agents.
Packaged agent skills for driving this provider's APIs from an AI assistant.
Scroll for all 8
GraphQL schemas published by this provider.
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
Notable capabilities this provider offers.
Atlas M0 Free shared cluster (512 MB, 100 ops/sec)
Atlas Flex with $8-$30/month capped pricing
Atlas Dedicated M10+ from ~$0.08/hr ($57/month)
Atlas Serverless: $0.10/M reads, $1.00/M writes, $0.025/GB-month storage
Atlas Search and Atlas Vector Search
Atlas Stream Processing
Atlas Data Federation across S3 and Atlas
Atlas Data API and GraphQL API
Atlas App Services (formerly Realm)
Atlas Admin API for programmatic cluster management
Multi-cloud across AWS, Azure, GCP
Multi-region clusters with global write zones
BI Connector for SQL access
Online archive for cold data tiering
Backups with point-in-time restore
VPC Peering and Private Endpoints
LDAP, X.509, and AWS IAM authentication
Scroll for all 17
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
Recommended x-agentic-access execution contracts for AI agents.
Get Started 2
Portal, sign-up, and the first successful call
Agent Surfaces 3
MCP servers, agent skills, and machine-readable catalogs
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 5
Authentication, authorization, and security posture
Operate 3
Status, limits, changes, and where to get help
Commercial 2
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Source (apis.yml)
aid: mongodb
name: MongoDB
description: MongoDB is a source-available cross-platform document-oriented database program. Classified as a NoSQL database,
MongoDB uses JSON-like documents with optional schemas.
type: Index
accessModel:
pricing: freemium
onboarding: self-serve
trial: false
try_now: true
public: false
label: Freemium · Self-serve signup
confidence: high
source:
- plans
- authentication
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/mongodb.png
tags:
- Cloud Database
- Database
- Document Database
- NoSQL
created: '2024'
modified: '2026-05-19'
url: https://www.mongodb.com
specificationVersion: '0.19'
apis:
- name: MongoDB Atlas Data API
description: The Atlas Data API lets you read and write data in MongoDB Atlas with standard HTTPS requests, without the
need for a MongoDB driver.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://www.mongodb.com/docs/atlas/app-services/data-api/
baseURL: https://data.mongodb-api.com/app
tags:
- Data Access
- HTTPS
- REST API
properties:
- type: Documentation
url: https://www.mongodb.com/docs/atlas/app-services/data-api/
- type: Examples
url: https://www.mongodb.com/docs/atlas/app-services/data-api/examples/
- name: MongoDB Atlas App Services Admin API
description: Admin API for MongoDB Atlas App Services (formerly Realm), used to manage applications, services, functions,
and triggers.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/
baseURL: https://realm.mongodb.com/api/admin/v3.0
tags:
- App Services
- Mobile
- Serverless
- Realm
properties:
- type: Documentation
url: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/
- aid: mongodb:mongodb-access-tracking-api
name: MongoDB Access Tracking API
description: Returns access logs for authentication attempts made to Atlas database deployments. To view database access
history, you must have either the Project Owner or Organization Owner role.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Access Tracking
properties:
- type: OpenAPI
url: openapi/mongodb-access-tracking-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-activity-feed-api
name: MongoDB Activity Feed API
description: Returns pre-filtered activity feed links for projects and organizations. The returned links can be shared and
opened to view the activity feed with the specified filters applied.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Activity Feed
properties:
- type: OpenAPI
url: openapi/mongodb-activity-feed-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-alert-configurations-api
name: MongoDB Alert Configurations API
description: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection
remains under revision and may change.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Alert Configurations
properties:
- type: OpenAPI
url: openapi/mongodb-alert-configurations-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-alerts-api
name: MongoDB Alerts API
description: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.
This collection remains under revision and may change.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Alerts
properties:
- type: OpenAPI
url: openapi/mongodb-alerts-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-atlas-search-api
name: MongoDB Atlas Search API
description: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates
user-defined analyzers for the specified cluster.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Atlas Search
properties:
- type: OpenAPI
url: openapi/mongodb-atlas-search-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-auditing-api
name: MongoDB Auditing API
description: Returns and edits database auditing settings for MongoDB Cloud projects.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Auditing
properties:
- type: OpenAPI
url: openapi/mongodb-auditing-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-aws-clusters-dns-api
name: MongoDB AWS Clusters DNS API
description: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires
your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable
custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB
Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved
to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection
strings.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- AWS Clusters DNS
properties:
- type: OpenAPI
url: openapi/mongodb-aws-clusters-dns-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-cloud-backups-api
name: MongoDB Cloud Backups API
description: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies
only to clusters that use Cloud Backups.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Cloud Backups
properties:
- type: OpenAPI
url: openapi/mongodb-cloud-backups-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-cloud-migration-service-api
name: MongoDB Cloud Migration Service API
description: Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager
or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't
use any authentication except SCRAM-SHA.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Cloud Migration Service
properties:
- type: OpenAPI
url: openapi/mongodb-cloud-migration-service-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-cloud-provider-access-api
name: MongoDB Cloud Provider Access API
description: Returns, adds, authorizes, and removes AWS IAM roles in Atlas.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Cloud Provider Access
properties:
- type: OpenAPI
url: openapi/mongodb-cloud-provider-access-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-cluster-outage-simulation-api
name: MongoDB Cluster Outage Simulation API
description: Returns, starts, or ends a cluster outage simulation.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Cluster Outage Simulation
properties:
- type: OpenAPI
url: openapi/mongodb-cluster-outage-simulation-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-clusters-api
name: MongoDB Clusters API
description: Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs.
This resource requires your Project ID.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Clusters
properties:
- type: OpenAPI
url: openapi/mongodb-clusters-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-collection-level-metrics-api
name: MongoDB Collection Level Metrics API
description: Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level
latency metric data.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Collection Level Metrics
properties:
- type: OpenAPI
url: openapi/mongodb-collection-level-metrics-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-custom-database-roles-api
name: MongoDB Custom Database Roles API
description: Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom
sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for
all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of
custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles
must include actions that all project's clusters support, and that are compatible with each MongoDB version that your
project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use
actions introduced in MongoDB 4.4.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Custom Database Roles
properties:
- type: OpenAPI
url: openapi/mongodb-custom-database-roles-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-data-federation-api
name: MongoDB Data Federation API
description: Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes
to federated database instance configurations can affect costs.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Data Federation
properties:
- type: OpenAPI
url: openapi/mongodb-data-federation-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-data-lake-pipelines-api
name: MongoDB Data Lake Pipelines API
description: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Data Lake Pipelines
properties:
- type: OpenAPI
url: openapi/mongodb-data-lake-pipelines-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-database-users-api
name: MongoDB Database Users API
description: Returns, adds, edits, and removes database users.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Database Users
properties:
- type: OpenAPI
url: openapi/mongodb-database-users-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-encryption-at-rest-using-customer-key-management-api
name: MongoDB Encryption at Rest using Customer Key Management API
description: Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts
all storage whether or not you use your own key management.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Encryption at Rest using Customer Key Management
properties:
- type: OpenAPI
url: openapi/mongodb-encryption-at-rest-using-customer-key-management-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-events-api
name: MongoDB Events API
description: Returns events. This collection remains under revision and may change.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Events
properties:
- type: OpenAPI
url: openapi/mongodb-events-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-federated-authentication-api
name: MongoDB Federated Authentication API
description: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization
configurations.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Federated Authentication
properties:
- type: OpenAPI
url: openapi/mongodb-federated-authentication-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-flex-clusters-api
name: MongoDB Flex Clusters API
description: Returns, adds, edits, and removes flex clusters.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Flex Clusters
properties:
- type: OpenAPI
url: openapi/mongodb-flex-clusters-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-flex-restore-jobs-api
name: MongoDB Flex Restore Jobs API
description: Returns and adds restore jobs for flex database deployments.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Flex Restore Jobs
properties:
- type: OpenAPI
url: openapi/mongodb-flex-restore-jobs-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-flex-snapshots-api
name: MongoDB Flex Snapshots API
description: Returns and requests to download flex database deployment snapshots.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Flex Snapshots
properties:
- type: OpenAPI
url: openapi/mongodb-flex-snapshots-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-global-clusters-api
name: MongoDB Global Clusters API
description: 'Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in
a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB
Cloud creates an empty collection for that namespace. Creating a managed namespace doesn''t populate a collection with
data. Similarly, deleting a managed namespace doesn''t delete the associated collection.
MongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your
custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one
or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code
to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For
example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage
custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your
Global Cluster.'
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Global Clusters
properties:
- type: OpenAPI
url: openapi/mongodb-global-clusters-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-invoices-api
name: MongoDB Invoices API
description: Returns invoices.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Invoices
properties:
- type: OpenAPI
url: openapi/mongodb-invoices-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-ldap-configuration-api
name: MongoDB LDAP Configuration API
description: Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB
Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible
to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You
must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization
with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster
using a version of MongoDB 3.6 or lower.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- LDAP Configuration
properties:
- type: OpenAPI
url: openapi/mongodb-ldap-configuration-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-legacy-backup-api
name: MongoDB Legacy Backup API
description: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Legacy Backup
properties:
- type: OpenAPI
url: openapi/mongodb-legacy-backup-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-maintenance-windows-api
name: MongoDB Maintenance Windows API
description: Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires
at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance
event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly
one week after the previously scheduled date and time.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- Maintenance Windows
properties:
- type: OpenAPI
url: openapi/mongodb-maintenance-windows-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-graphql.md
- aid: mongodb:mongodb-mongodb-cloud-users-api
name: MongoDB MongoDB Cloud Users API
description: Returns, adds, and edits MongoDB Cloud users.
humanURL: https://www.mongodb.com/docs/atlas/api/
baseURL: https://cloud.mongodb.com/api/atlas/v2
tags:
- MongoDB Cloud Users
properties:
- type: OpenAPI
url: openapi/mongodb-mongodb-cloud-users-api-openapi.yml
- type: Documentation
url: https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
- type: Authentication
url: https://www.mongodb.com/docs/atlas/api/api-authentication/
- type: RateLimits
url: https://www.mongodb.com/docs/atlas/api/api-rate-limit/
- type: Versioning
url: https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
- type: ChangeLog
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/
- type: GraphQL
url: graphql/mongodb-grap
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/apis.yml