Navigation

Get All Private Endpoint Services for One Provider

Info With Circle IconCreated with Sketch.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 services for AWS or Azure in 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/{CLOUD-PROVIDER}/endpointService
Path ParameterTypeNecessityDescription
{GROUP-ID}stringRequiredUnique identifier for the project that contains the private endpoint services that you want to retrieve.
{CLOUD-PROVIDER}stringRequiredCloud provider for which you want to retrieve private endpoint services. Atlas accepts AWS or AZURE.
NameTypeNecessityDescriptionDefault
prettybooleanOptionalFlag indicating whether the response body should be in a prettyprint format.false
envelopebooleanOptional

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
false

This endpoint doesn't use HTTP request body parameters.

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

NameTypeDescription
resultsarray of objectsOne object for each item detailed in the results Embedded Document section.
linksarray of objectsOne or more links to sub-resources and/or related resources. The relations between URL s are explained in the Web Linking Specification
totalCountintegerCount of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
Response ParameterTypeDescription
endpointServiceNamestringName of the AWS PrivateLink endpoint service. Atlas returns null while it is creating the endpoint service.
errorMessagestringError message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
idstringUnique identifier of the AWS PrivateLink connection.
interfaceEndpointsarray of stringsUnique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
statusstring

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

StatusDescription
INITIATINGAtlas 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.

FAILEDA system failure has occurred.
DELETINGThe AWS PrivateLink connection is being deleted.
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/{CLOUD-PROVIDER}/endpointService?pretty=true"
1[
2 {
3 "endpointServiceName": "com.amazonaws.vpce.us-east-2.vpce-svc-0fec9a0700b25cd2f",
4 "errorMessage": null,
5 "id": "5f7cac1e8becbf2e769f7abd",
6 "interfaceEndpoints": [],
7 "status": "WAITING_FOR_USER"
8 },
9 {
10 "endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0afd34ee97e30d43f",
11 "errorMessage": null,
12 "id": "5f7cac1adf5d6c6306f4b283",
13 "interfaceEndpoints": [],
14 "status": "WAITING_FOR_USER"
15 }
16]
Give Feedback