Navigation

Delete One Private Endpoint Connection

Important
Deprecated
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 authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

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

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

DELETE /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}
Path Parameter
Required/Optional
Description
GROUP-ID
Required
Unique identifier for the project.
privateLinkId
Required
Unique identifier of the AWS PrivateLink connection.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These 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
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

This endpoint does not have response elements.

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

This endpoint returns an empty JSON object.

Give Feedback