security

List VPC Private Endpoints

Changed on

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

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

Request

  • Base URL
    https://services.cloud.mongodb.com/api/admin/v3.0
  • URL
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/security/private_endpoints
  • Auth
    HTTP bearer

Response

Successfully listed endpoints.

_idstring
cloud_provider_regionstring

The cloud provider region that hosts the private endpoint.

cloud_provider_endpoint_idstring

The private endpoint ID from the cloud provider.

commentstring

An optional comment that describes the endpoint.

endpoint_type'sync' | 'general' | 'legacy'

The type of endpoint. For more information on migrating deprecated "legacy" endpoints, see Migrate Legacy Endpoints.

Example response

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

Changes