List VPC Private Endpoint Services

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

Token auth

Get a list of all private endpoint services 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 services.
Hide response attributes Show response attributes object
- cloud_provider_region string
- service_name string
- 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.

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

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

Response examples (200)

[
  {
    "cloud_provider_region": "aws-us-east-1",
    "service_name": "com.amazonaws.vpce.us-east-1.vpce-svc-0f24fc6e6de007e5e",
    "endpoint_type": "sync"
  }
]