Navigation

Delete One Private Endpoint for One Provider

Info With Circle IconCreated with Sketch.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.

Delete one private endpoint for AWS or Azure from an Atlas project.

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 at the Project Owner role for the project to successfully call this resource.

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

DELETE /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint/{ENDPOINT-ID}
Path ParameterTypeNecessityDescription
{GROUP-ID}stringRequiredUnique identifier for the project for which you want to delete a private endpoint.
{CLOUD-PROVIDER}stringRequiredCloud provider for which you want to delete a private endpoint. Atlas accepts AWS or AZURE.
{ENDPOINT-SERVICE-ID}stringRequiredUnique identifier of the private endpoint service from which you want to delete a private endpoint.
{ENDPOINT-ID}stringRequired

Unique identifier of the private endpoint you want to delete.

The format of the {ENDPOINT-ID} parameter differs for AWS and Azure :

vpce-09af09a5ae5826fc3
NameTypeDescriptionDefault
envelopeboolean

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, response body includes:

statusHTTP response code
envelopeThe expected response body

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the 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/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint/{ENDPOINT-ID}?pretty=true"

This endpoint returns an empty JSON Object.

Give Feedback