Create a VPC Private Endpoint

POST /groups/{groupId}/apps/{appId}/security/private_endpoints
Token auth

Configure a new private endpoint for the App.

Path parameters

application/json

Body Required

  • cloud_provider_region string Required

    The cloud provider region that hosts the private endpoint.

  • cloud_provider_endpoint_id string Required

    The private endpoint ID from the cloud provider.

  • comment string

    An optional comment that describes the endpoint.

  • endpoint_type string Required

    The type of endpoint. For more information on endpoint types and migrating deprecated endpoints to "general" or "sync", see Use a VPC Private Endpoint.

    Values are sync or general.

Responses

  • 201 application/json

    Created

    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.
  • 400
    • Bad Request
    • VPC endpoint id (cloud_provider_endpoint_id) is invalid
    • Endpoint type is "legacy"
POST /groups/{groupId}/apps/{appId}/security/private_endpoints 
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/security/private_endpoints' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"cloud_provider_region":"aws-us-east-1","cloud_provider_endpoint_id":"vpce-12345678","comment":"string","endpoint_type":"sync"}'
Request examples 
{
  "cloud_provider_region": "aws-us-east-1",
  "cloud_provider_endpoint_id": "vpce-12345678",
  "comment": "string",
  "endpoint_type": "sync"
}
Response examples (201) 
{
  "_id": "string",
  "cloud_provider_region": "aws-us-east-1",
  "cloud_provider_endpoint_id": "vpce-12345678",
  "comment": "string",
  "endpoint_type": "sync"
}