security

Modify a VPC Private Endpoint

Changed on

Update the configuration of a private endpoint.

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

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/{privateEndpointId}
  • Auth
    HTTP bearer

Request body

cloud_provider_regionstring required

The cloud provider region that hosts the private endpoint.

cloud_provider_endpoint_idstring required

The private endpoint ID from the cloud provider.

commentstring

An optional comment that describes the endpoint.

endpoint_type'sync' | 'general' 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.

Example request

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

Response

Updated

_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

  • v3aec31f78ae64Revision changes
    • breaking

      added the new required request property

    • breaking

      the request property became required

    • breaking

      the request property became required

    • warning

      removed the request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • v3e2240dd053bdRevision changes
    • info

      added the media type application/json for the response with the status