Navigation

Get All Private Endpoint Connections

Deprecated

This endpoint is deprecated. Please use /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService instead.

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 details for all private endpoint connections in an 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.

Required Roles

You must have one of the following roles to successfully call this resource:

Request

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

GET /groups/{GROUP-ID}/privateEndpoint

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required Unique identifier for the project.

Request Query Parameters

Name Type Necessity Description Default
pageNum integer Optional Page number, starting with one, that Atlas returns of the total number of objects. 1
itemsPerPage integer Optional Number of items that Atlas returns per page, up to a maximum of 500. 100
includeCount boolean Optional Flag that indicates whether Atlas returns the totalCount parameter in the response body. true
pretty boolean Optional Flag that indicates whether Atlas returns the JSON response in the prettyprint format. false
envelope boolean Optional

Flag that indicates whether Atlas wraps the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

false

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.

Response Elements

The HTTP response returns a JSON document that includes an array of private endpoint connection definitions. Each private endpoint connection definition contains the following elements:

Response Parameter Type Description
endpointServiceName string Name of the AWS PrivateLink endpoint service. Atlas returns null while it is creating the endpoint service.
errorMessage string Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
id string Unique identifier of the AWS PrivateLink connection.
interfaceEndpoints array of strings Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
status string

Status of the AWS PrivateLink connection. Atlas returns one of the following values:

Status Description
INITIATING Atlas is creating the network load balancer and VPC endpoint service.
WAITING_FOR_USER

The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests.

When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.

FAILED A system failure has occurred.
DELETING The AWS PrivateLink connection is being deleted.

Example Request

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

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
[
  {
    "endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0aee615d3fe32c14e",
    "errorMessage": null,
    "id": "5df264b8f10fab7d2cad2f0d",
    "interfaceEndpoints": ["vpce-05934e68436496102"],
    "status": "WAITING_FOR_USER"
  },
  {
    "endpointServiceName": "com.amazonaws.vpce.us-west-1.vpce-svc-4fbdd5faa86d2e7538",
    "errorMessage": null,
    "id": "5758160cc363b548152501c2",
    "interfaceEndpoints": ["vpce-08fb7e9319909ec7b"],
    "status": "WAITING_FOR_USER"
  }
]