Docs Menu

Get All Private Endpoints

On this page

  • Permissions Required
  • Resources
  • Syntax
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • links Array
  • results Array
  • totalCount Document
  • Example
  • Request
  • Response

You can retrieve all the AWS private endpoints for the federated database instances in the project from the API.

The Atlas Administration 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 Get Started with the Atlas Administration API.

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.

You must have the GROUP_READ_ONLY (Project Data Access Read Only) or higher role to retrieve private endpoints.

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

GET /groups/{GROUP-ID}/privateNetworkSettings/endpointIds
Path Element
Necessity
Description
GROUP-ID
Required
Unique 24-digit hexadecimal string that identifies the project.

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

This endpoint does not use HTTP request body parameters.

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.

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 Federation supports AWS private endpoints using the AWS PrivateLink 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.

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
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"
Example
{
"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
}
←  Get All Federated Database InstancesGet One Federated Database Instance →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.