Navigation

Get One Private Endpoint for One Provider

On this page

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.

Required Roles

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

Request

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

copy 
GET /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint/{ENDPOINT-ID}

Request Path Parameters

Path Parameter Type Necessity Description
{GROUP-ID} string Required Unique identifier for the project for which you want to retrieve a private endpoint.
{CLOUD-PROVIDER} string Required Cloud provider for which you want to retrieve a private endpoint. Atlas accepts AWS or AZURE.
{ENDPOINT-SERVICE-ID} string Required Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
{ENDPOINT-ID} string Required

Unique identifier of the private endpoint you want to retrieve.

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

vpce-09af09a5ae5826fc3

%2Fsubscriptions%2F00000000-0000-0000-0000-000000000000%2FresourceGroups%2Fprivatelink%2Fproviders%2FMicrosoft.Network%2FprivateEndpoints%2Ftest

Important

You must URL encode the {ENDPOINT-ID} for Azure private endpoints.

Request Query Parameters

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

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.

Response Elements

Response Parameter Type Description
connectionStatus string

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

Status Description
NONE Atlas created the network load balancer and VPC endpoint service, but AWS hasn’t yet created the VPC endpoint.
PENDING_ACCEPTANCE AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
PENDING AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
AVAILABLE Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
REJECTED AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
DELETING Atlas is removing the interface endpoint from the private endpoint connection.
deleteRequested boolean Flag that indicates whether Atlas received a request to remove the interface endpoint from the private endpoint connection.
errorMessage string Error message pertaining to the interface endpoint. Atlas returns null if there are no errors.
interfaceEndpointId string Unique identifier of the interface endpoint.
Response Parameter Type Description
deleteRequested boolean Flag that indicates whether Atlas received a request to remove the delete the private endpoint connection.
errorMessage string Error message pertaining to the private endpoint. Atlas returns null if there are no errors.
privateEndpointConnectionName string Name of the connection for this private endpoint that Atlas generates.
privateEndpointIpAddress string Private IP address of the private endpoint network interface.
privateEndpointResourceId string Unique identifier of the private endpoint.
status string

Status of the interface endpoint. Atlas returns one of the following values:

Status Description
FAILED Atlas failed to accept the connection your private endpoint.
INITIATING Atlas has not yet accepted the connection to your private endpoint.
AVAILABLE Atlas approved the connection to your private endpoint.
DELETING Atlas is removing the connection to your private endpoint from the Private Link service.

Example Request

copy 
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/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint/{ENDPOINT-ID}?pretty=true"

Example Response

1
2
3
4
5
6
{
  "connectionStatus": "PENDING",
  "deleteRequested": false,
  "errorMessage": null,
  "interfaceEndpointId": "vpce-08fb7e9319909ec7b"
}

1
2
3
4
5
6
7
8
{
  "deleteRequested": false,
  "errorMessage": null,
  "privateEndpointConnectionName": null,
  "privateEndpointIPAddress": "10.0.0.4",
  "privateEndpointResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/privatelink/providers/Microsoft.Network/privateEndpoints/test",
  "status": "INITIATING"
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.