Verify Connect via Peering Only Mode for a Project

Info With Circle IconCreated with Sketch.Note
Deprecated Feature

This feature has been deprecated. Use Split Horizon connection strings to connect to your cluster. These connection strings allow you to connect using both VPC /VNet Peering and allowed public IP addresses. To learn more about support for Split Horizon, see this FAQ. Use the Disable Connect via Peering Only Mode for a Project endpoint to disable Peering Only.

Verify whether an Atlas project has enabled Connect via Peering Only mode. You must have the Project Read Only role to successfully call this endpoint.

Base URL:

GET /groups/{GROUP-ID}/privateIpMode
Body ParameterTypeNecessityDescription
GROUP-IDstringRequiredUnique identifier of N Atlas project for which you want to enable Connect via Peering Only mode.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

prettybooleanOptionalFlag indicating whether the response body should be in a prettyprint format.false

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

statusHTTP response code
envelopeExpected response body

This endpoint doesn't use HTTP request body parameters.

Response ElementTypeDescription
enabledbooleanIndicates whether Connect via Peering Only mode is enabled or disabled for an Atlas project.
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request GET "{GROUP-ID}/privateIpMode?pretty=true"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
2 "enabled" : true
Give Feedback