Navigation

Get All Private Endpoint Services for One Provider

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.

Required Roles

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

Request

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

GET /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService

Request Path Parameters

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

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 Document

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.

Name Type Description
results array of objects One object for each item detailed in the results Embedded Document section.
links array of objects One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification
totalCount integer Count 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.

results Embedded Document

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.
Response Parameter Type Description
errorMessage string Error message pertaining to the Azure Private Link Service. Returns null if there are no errors.
id string Unique identifier of the Azure Private Link Service.
privateEndpoints array of strings All private endpoints that you have added to this Azure Private Link Service.
privateLinkServiceName string Name of the Azure Private Link Service that Atlas manages.
privateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

Important

You must use this value when you create a private endpoint connection to an Azure VNet.

status string

Status of the Azure Private Link Service. Returns one of the following values:

Status Description
AVAILABLE Atlas created the load balancer and the Private Link Service.
INITIATING Atlas is creating the load balancer and the Private Link Service.
FAILED Atlas failed to create the load balancer and the Private Link service.
DELETING Atlas is deleting the Private Link service.

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/{CLOUD-PROVIDER}/endpointService?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-2.vpce-svc-0fec9a0700b25cd2f",
    "errorMessage": null,
    "id": "5f7cac1e8becbf2e769f7abd",
    "interfaceEndpoints": [],
    "status": "WAITING_FOR_USER"
  },
  {
    "endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0afd34ee97e30d43f",
    "errorMessage": null,
    "id": "5f7cac1adf5d6c6306f4b283",
    "interfaceEndpoints": [],
    "status": "WAITING_FOR_USER"
  }
]
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
  {
    "errorMessage": null,
    "id": "5f7c8d4702d59b7fc0b4b842",
    "privateEndpoints": [],
    "privateLinkServiceName": "pls_5f7b96cd8c39f93d0e5f1911",
    "privateLinkServiceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg_5f7b96cd8c39f93d0e5f1911_8nw06xue/providers/Microsoft.Network/privateLinkServices/pls_5f7b96cd8c39f93d0e5f1911",
    "status": "AVAILABLE"
  },
  {
    "errorMessage": null,
    "id": "5f7c8d6d02d59b7fc0b4b899",
    "privateEndpoints": [],
    "privateLinkServiceName": "pls_5f7c8d6d02d59b7fc0b4b89a",
    "privateLinkServiceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg_5f7c8d6d02d59b7fc0b4b89a_pvrxsft6/providers/Microsoft.Network/privateLinkServices/pls_5f7c8d6d02d59b7fc0b4b89a",
    "status": "AVAILABLE"
  }
]