How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Data Federation API

Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.

MongoDB Data Federation API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Federation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 14 operations across 7 paths, and defines 35 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.

14 operations 7 paths 35 schemas 3 DELETE7 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Data Federation 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 14

Across 7 paths, the API surfaces 14 operations — 3 DELETE, 7 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Data Federation 14

Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.

GET
/api/atlas/v2/groups/{groupId}/dataFederation
Return All Federated Database Instances in One Project
listGroupDataFederation 4 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/dataFederation
Create One Federated Database Instance in One Project
createGroupDataFederation 4 params body → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}
Remove One Federated Database Instance from One Project
deleteGroupDataFederation 4 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}
Return One Federated Database Instance in One Project
getGroupDataFederation 3 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}
Update One Federated Database Instance in One Project
updateGroupDataFederation 5 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits
Return All Query Limits for One Federated Database Instance
listGroupDataFederationLimits 4 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}
Delete One Query Limit for One Federated Database Instance
deleteGroupDataFederationLimit 4 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}
Return One Federated Database Instance Query Limit for One Project
getGroupDataFederationLimit 5 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}
Configure One Query Limit for One Federated Database Instance
setGroupDataFederationLimit 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz
Download Query Logs for One Federated Database Instance
downloadGroupDataFederationQueryLogs 4 params → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds
Return All Federated Database Instance and Online Archive Private Endpoints in One Project
listGroupPrivateNetworkSettingEndpointIds 6 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds
Create One Federated Database Instance and Online Archive Private Endpoint for One Project
createGroupPrivateNetworkSettingEndpointId 3 params body → 201400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}
Remove One Federated Database Instance and Online Archive Private Endpoint from One Project
deleteGroupPrivateNetworkSettingEndpointId 4 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}
Return One Federated Database Instance and Online Archive Private Endpoint in One Project
getGroupPrivateNetworkSettingEndpointId 4 params → 200400401403404429500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are DataLakeDatabaseDataSourceSettings (13 properties), PrivateNetworkEndpointIdEntry (10 properties), DataFederationTenantQueryLimit (8 properties), DataLakeTenant (8 properties). Each schema is shown below with its type and property counts.

DataLakeDatabaseDataSourceSettings
object
Data store that maps to a collection for this data lake.
13 properties
DataFederationGCPCloudProviderConfig
object
Configuration for running Data Federation in GCP.
2 properties 1 required
DataLakeDLSGCPStore
object
DataLakeHTTPStore
object
DataLakeS3StoreSettings
object
BaseAtlasDataLakeRegion
object
Name of the region to which the data lake routes client connections.
DataLakeAtlasStoreInstance
object
DataLakeDLSAzureStore
object
ApiError
object
6 properties 2 required
DataLakeGoogleCloudStorageStore
object
Link
object
2 properties
PaginatedPrivateNetworkEndpointIdEntryView
object
3 properties 1 required
DataLakeAzureBlobStore
object
DataLakeDatabaseInstance
object
Database associated with this data lake. Databases contain collections and views.
4 properties
DataLakeStorage
object
Configuration information for each data store and its mapping to MongoDB Cloud databases.
2 properties
FieldViolation
object
2 properties 2 required
DataLakeDataProcessRegion
object
Information about the cloud provider region to which the Federated Database Instance routes client connections.
2 properties 2 required
DataFederationTenantQueryLimit
object
Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.
8 properties 2 required
ApiAtlasDataLakeAWSRegionView
string
Atlas Data Federation AWS Regions.
DataLakeAtlasStoreReadConcern
object
MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.
1 property
DataLakeApiBase
object
An aggregation pipeline that applies to the collection.
3 properties
DataLakeCloudProviderConfig
object
Cloud provider where this Federated Database Instance is hosted.
3 properties
DataLakeAtlasStoreReadPreferenceTag
object
2 properties
AtlasDataFederationGCPRegion
string
Atlas Data Federation GCP Regions.
DataLakeDatabaseCollection
object
A collection and data sources that map to a stores data store.
2 properties
PrivateNetworkEndpointIdEntry
object
10 properties 1 required
AtlasDataFederationAzureRegion
string
Atlas Data Federation Azure Regions.
DataLakeAWSCloudProviderConfig
object
Configuration for running Data Federation in AWS.
5 properties 2 required
BadRequestDetail
object
Bad request detail.
1 property
DataFederationAzureCloudProviderConfig
object
Configuration for running Data Federation in Azure.
4 properties 1 required
DataLakeDLSAWSStore
object
DataLakeStoreSettings
object
Group of settings that define where the data is stored.
2 properties 1 required
PrivateEndpointHostname
object
Set of Private endpoint and hostnames.
2 properties
DataLakeAtlasStoreReadPreference
object
MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.
3 properties
DataLakeTenant
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-data-federation-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

This is an independent, third-party profile of MongoDB Data Federation 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.