MongoDB Global Clusters API
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.
MongoDB Global Clusters API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Global Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.
This API exposes 5 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://cloud.mongodb.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
MongoDB Global Clusters API declares
2 security schemes
for authenticating requests.
It uses HTTP digest authentication (DigestAuth).
It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow.
By default, every request must be authenticated.
ServiceAccounts— Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 2 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
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…
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ManagedNamespaces (7 properties), ApiError (6 properties), GeoSharding20240805 (3 properties), ZoneMapping (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from MongoDB 12
Other APIs MongoDB publishes across the network.
This is an independent, third-party profile of MongoDB Global Clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.