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 Network Peering API

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 and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.

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

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

This API exposes 13 operations across 6 paths, and defines 16 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.

13 operations 6 paths 16 schemas 2 DELETE6 GET3 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 Network Peering 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 13

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

Network Peering 13

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 and…

GET
/api/atlas/v2/groups/{groupId}/containers
Return All Network Peering Containers in One Project for One Cloud Provider
listGroupContainers 7 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/containers
Create One Network Peering Container
createGroupContainer 3 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/containers/all
Return All Network Peering Containers in One Project
listGroupContainerAll 6 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/containers/{containerId}
Remove One Network Peering Container
deleteGroupContainer 4 params → 204400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/containers/{containerId}
Return One Network Peering Container
getGroupContainer 4 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/containers/{containerId}
Update One Network Peering Container
updateGroupContainer 4 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/peers
Return All Network Peering Connections in One Project
listGroupPeers 7 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/peers
Create One Network Peering Connection
createGroupPeer 3 params body → 200400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/peers/{peerId}
Remove One Network Peering Connection
deleteGroupPeer 4 params → 202401403404409429500
GET
/api/atlas/v2/groups/{groupId}/peers/{peerId}
Return One Network Peering Connection in One Project
getGroupPeer 4 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/peers/{peerId}
Update One Network Peering Connection
updateGroupPeer 4 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/privateIpModedeprecated
Verify Connect via Peering-Only Mode for One Project
verifyGroupPrivateIpMode 3 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/privateIpModedeprecated
Disable Connect via Peering-Only Mode for One Project
disableGroupPrivateIpModePeering 3 params body → 200400401403404429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are AwsNetworkPeeringConnectionSettings (10 properties), AzureNetworkPeeringConnectionSettings (9 properties), GCPNetworkPeeringConnectionSettings (7 properties), ApiError (6 properties). Each schema is shown below with its type and property counts.

AWSCloudProviderContainer
object
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.
1 required
RequestAccepted
object
Accepted.
GCPCloudProviderContainer
object
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.
2 required
AzureCloudProviderContainer
object
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.
2 required
ApiError
object
6 properties 2 required
Link
object
2 properties
AwsNetworkPeeringConnectionSettings
object
Group of Network Peering connection settings.
10 properties 5 required
FieldViolation
object
2 properties 2 required
GCPNetworkPeeringConnectionSettings
object
Group of Network Peering connection settings.
7 properties 3 required
PaginatedContainerPeerView
object
Group of Network Peering connection settings.
3 properties 1 required
CloudProviderContainer
object
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.
3 properties
PrivateIPModeView
object
1 property 1 required
BaseNetworkPeeringConnectionSettings
object
3 properties 1 required
AzureNetworkPeeringConnectionSettings
object
Group of Network Peering connection settings.
9 properties 5 required
PaginatedCloudProviderContainerView
object
List of Network Peering Containers that Amazon Web Services serves.
3 properties 1 required
BadRequestDetail
object
Bad request detail.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-network-peering-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 Network Peering 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.