Get All Private Endpoints
On this page
You can retrieve all the AWS private endpoints for the Data Lakes in the project from the API.
The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.
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.
Permissions Required
You must have the GROUP_READ_ONLY (Project Data Access Read Only) or higher role to retrieve private endpoints.
Resources
Base URL
https://cloud.mongodb.com/api/atlas/v1.0
Syntax
GET /groups/{GROUP-ID}/privateNetworkSettings/endpointIds
Request Parameters
Request Path Parameters
Path Element | Necessity | Description |
|---|---|---|
GROUP-ID | Required | Unique 24-digit hexadecimal string that identifies the
project. |
Request Query Parameters
The following query parameters are optional:
Query Parameter | Type | Description | Default |
|---|---|---|---|
pretty | boolean | Displays response in a prettyprint format. | false |
envelope | boolean | Specifies whether or not to wrap the response in an envelope. | false |
Request Body Parameters
This endpoint does not use HTTP request body parameters.
Response Elements
links Array
The links array includes one or more links to sub-resources or
related resources. The relations between URLs are explained in the Web
Linking Specification.
Relation | Description |
|---|---|
self | The URL endpoint for this resource. |
results Array
Each element in the result array is one private endpoint.
Name | Type | Description |
|---|---|---|
comment | string | Human-readable string associated with this private endpoint. |
endpointId | string | Unique 22-character alphanumeric string that identifies the
private endpoint. Atlas Data Lake supports AWS private endpoints using
the {aws-pl+} feature. |
provider | string | Human-readable label that identifies the cloud provider for this
endpoint. Value is AWS. |
type | string | Human-readable label that identifies the resource associated
with this private endpoint. Value is DATA_LAKE. |
totalCount Document
This value is the count of the total number of items in the result set.
totalCount may be greater than the number of objects in the
results array if the entire result set is paginated.
Example
Request
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateNetworkSettings/endpointIds?pretty=true"
Response
{ "links" : [ { "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateNetworkSettings/endpointIds?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "comment" : "Private endpoint for Application Server A", "endpointId" : "vpce-jjg5e24qp93513h03", "provider" : "AWS", "type" : "DATA_LAKE" } ], "totalCount" : 1 }