Delete One Private Endpoint Service for One Provider¶
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 service for AWS or Azure in 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}
Request Path Parameters¶
| Path Parameter | Type | Necessity | Description |
|---|---|---|---|
| {GROUP-ID} | string | Required | Unique identifier for the project that contains the private endpoint service that you want to delete. |
| {CLOUD-PROVIDER} | string | Required | Cloud provider for which you want to delete a private endpoint service. Atlas accepts AWS or AZURE. |
| {ENDPOINT-SERVICE-ID} | string | Required | Unique identifier of the private endpoint service that you want to delete. |
Request Query Parameters¶
| Name | Type | Description | Default | ||||
|---|---|---|---|---|---|---|---|
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 For endpoints that return one result, response body includes:
For endpoints that return a list of results, the | 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}?pretty=true"
Example Response¶
This endpoint returns an empty JSON Object.