Delete One Private Endpoint for One Provider¶

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.

Required Roles¶

You must have at the Project Owner role for the project to successfully call this resource.

Request¶

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

DELETE /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint/{ENDPOINT-ID}

Request Path Parameters¶

Path Parameter	Type	Necessity	Description
{GROUP-ID}	string	Required	Unique identifier for the project for which you want to delete a private endpoint.
{CLOUD-PROVIDER}	string	Required	Cloud provider for which you want to delete a private endpoint. Atlas accepts AWS or AZURE.
{ENDPOINT-SERVICE-ID}	string	Required	Unique identifier of the private endpoint service from which you want to delete a private endpoint.
{ENDPOINT-ID}	string	Required	Unique identifier of the private endpoint you want to delete. The format of the {ENDPOINT-ID} parameter differs for AWS and Azure:

Request Query Parameters¶

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

Request Body Parameters¶

This endpoint doesn't use HTTP request body parameters.

Response Elements¶

This endpoint does not have response elements.

Example Request¶

1 curl --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"

Example Response¶

This endpoint returns an empty JSON Object.

Give Feedback

← Create One Private Endpoint for One Provider Get Regionalized Private Endpoint Status →

1	curl --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"