List VPC Private Endpoints

GET /groups/{groupId}/apps/{appId}/security/private_endpoints

Token auth

Get a list of all private endpoints configured for the App.

Path parameters

groupId string Required

An Atlas Project/Group ID.
appId string Required

The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

Responses

200 application/json

Successfully listed endpoints.
Hide response attributes Show response attributes object
- _id string
- cloud_provider_region string
  
  The cloud provider region that hosts the private endpoint.
- cloud_provider_endpoint_id string
  
  The private endpoint ID from the cloud provider.
- comment string
  
  An optional comment that describes the endpoint.
- endpoint_type string
  
  The type of endpoint. For more information on migrating deprecated "legacy" endpoints, see Migrate Legacy Endpoints.
  
  Values are sync, general, or legacy.
404

Not Found

GET /groups/{groupId}/apps/{appId}/security/private_endpoints

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/security/private_endpoints' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "_id": "string",
    "cloud_provider_region": "aws-us-east-1",
    "cloud_provider_endpoint_id": "vpce-12345678",
    "comment": "string",
    "endpoint_type": "sync"
  }
]