Navigation

Network Peering

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Endpoints

The following lists the endpoints available for Network Peering.

Method Endpoint Description
GET /groups/{GROUP-ID}/containers Get details for all network peering containers in an Atlas project for a single cloud provider.
GET /groups/{GROUP-ID}/containers/{CONTAINER-ID} Get details for one network peering container in an Atlas project.
POST /groups/{GROUP-ID}/containers Create one new network peering container in an Atlas project.
PATCH /groups/{GROUP-ID}/containers/{CONTAINER-ID} Update details for one network peering container in an Atlas project.
DELETE /groups/{GROUP-ID}/containers/{CONTAINER-ID} Remove one network peering container in an Atlas project.
GET /groups/{GROUP-ID}/peers Get details for all network peering connections in an Atlas project.
GET /groups/{GROUP-ID}/peers/{PEER-ID} Get details for one network peering connection in an Atlas project.
POST /groups/{GROUP-ID}/peers Create a new network peering connection in an Atlas project.
PATCH /groups/{GROUP-ID}/peers/{PEER-ID} Update a new network peering connection in an Atlas project.
DELETE /groups/{GROUP-ID}/peers/{PEER-ID} Delete one network peering connection in an Atlas project.
GET /groups/{GROUP-ID}/privateIpMode

Verify if an Atlas project is in Connect via Peering Only mode.

Note

Connect via Peering Only is required to use Network Peering with GCP and Azure.

PATCH /groups/{GROUP-ID}/privateIpMode

Enable or disable Connect via Peering Only mode for one Atlas project.

Note

Connect via Peering Only is required to use network peering with GCP and Azure.