Navigation

Get Regionalized Private Endpoint Status

On this page

  • Required Roles
  • Request
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Example Request
  • Example Response
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.

Retrieve whether the regionalized private endpoint setting is enabled for one Atlas project.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

You must have at least the Project Read Only role for the project to successfully call this resource.

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

GET /groups/{GROUP-ID}/privateEndpoint/regionalMode
Path Parameter
Type
Necessity
Description
{GROUP-ID}
string
Required
Unique identifier for the project for which you want to retrieve the status of the regionalized private endpoint setting.

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

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

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:

status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

Response Parameter
Type
Description
enabled
boolean

Flag that indicates whether the regionalized private endpoint setting is enabled for one Atlas project.

If this value is true, you can create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters.

If this value is false, you can't create more than one private endpoint in one cloud provider region if you have a private endpoint in a different region.

The default value is false.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/regionalMode?pretty=true"
1{
2 "enabled": false
3}
Give Feedback

On this page

  • Required Roles
  • Request
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Example Request
  • Example Response