Modify a VPC Private Endpoint

PUT /groups/{groupId}/apps/{appId}/security/private_endpoints/{privateEndpointId}

Token auth

Update the configuration of a private endpoint.

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.
privateEndpointId string Required

The _id ObjectID of a VPC private endpoint.

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

200 application/json

Updated
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
- VPC endpoint id (cloud_provider_endpoint_id) is invalid
- Attempted to change endpoint type
404

Not Found

PUT /groups/{groupId}/apps/{appId}/security/private_endpoints/{privateEndpointId}

curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/security/private_endpoints/{privateEndpointId}' \
 --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 (200)

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