Navigation

Get One Private Endpoint 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 one private endpoint for AWS or Azure 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.

You must have at 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/{ENDPOINT-SERVICE-ID}/endpoint/{ENDPOINT-ID}
Path ParameterTypeNecessityDescription
{GROUP-ID}stringRequiredUnique identifier for the project for which you want to retrieve a private endpoint.
{CLOUD-PROVIDER}stringRequiredCloud provider for which you want to retrieve a private endpoint. Atlas accepts AWS or AZURE.
{ENDPOINT-SERVICE-ID}stringRequiredUnique identifier of the private endpoint service for which you want to retrieve a private endpoint.
{ENDPOINT-ID}stringRequired

Unique identifier of the private endpoint you want to retrieve.

The format of the {ENDPOINT-ID} parameter differs for AWS and Azure :

vpce-09af09a5ae5826fc3
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.

Response ParameterTypeDescription
connectionStatusstring

Status of the interface endpoint. Returns one of the following values:

StatusDescription
NONEAtlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
PENDING_ACCEPTANCEAWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
PENDINGAWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
AVAILABLEAtlas VPC resources are connected to the VPC endpoint in your VPC . You can connect to Atlas clusters in this region using AWS PrivateLink.
REJECTEDAWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC .
DELETINGAtlas is removing the interface endpoint from the private endpoint connection.
deleteRequestedbooleanFlag that indicates whether Atlas received a request to remove the interface endpoint from the private endpoint connection.
errorMessagestringError message pertaining to the interface endpoint. Atlas returns null if there are no errors.
interfaceEndpointIdstringUnique identifier of the interface endpoint.
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/{ENDPOINT-SERVICE-ID}/endpoint/{ENDPOINT-ID}?pretty=true"
1{
2 "connectionStatus": "PENDING",
3 "deleteRequested": false,
4 "errorMessage": null,
5 "interfaceEndpointId": "vpce-08fb7e9319909ec7b"
6}
Give Feedback