Navigation

Delete One Private Endpoint Connection

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Remove one private endpoint connection in an Atlas project.

Important

You must remove all interface endpoints associated with a private endpoint before you can remove it.

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Required Roles

You must have one of the following roles to successfully call this resource:

Request

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

DELETE /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required Unique identifier for the project.
privateLinkId Required Unique identifier of the AWS PrivateLink connection.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

Indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status HTTP response code
envelope The expected response body
false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

This endpoint does not have response elements.

Example Request

1
2
3
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/

Example Response

This endpoint returns an empty JSON Object.