Delete an Entry from the Project IP Whitelist¶
Atlas now refers to its cluster firewall management as IP Access Lists. Atlas has deprecated the whitelist resource and will disable it in June 2021. Revise your whitelist endpoints to use the IP Access List resource.
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.
The /groups/{GROUP-ID}/whitelist endpoint manages the
Project IP Whitelist. This endpoint is
distinct from the
/users/{USER-ID}/whitelist
endpoint, which manages an Atlas user's
API whitelist.
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.
https://cloud.mongodb.com/api/atlas/v1.0
Syntax¶
DELETE /groups/{GROUP-ID}/whitelist/{WHITELIST-ENTRY}
Request Path Parameters¶
Path Element | Required/Optional | Description |
|---|---|---|
GROUP-ID | Required. | The unique identifier for the project for
which you want to delete a whitelist entry. |
WHITELIST-ENTRY | Required. | Can be either the:
of the whitelist entry to delete. If the entry includes a subnet
mask, such as Important When you remove an entry from the IP access list, existing connections from the removed address(es) may remain open for a variable amount of time. How much time passes before Atlas closes the connection depends on several factors, including:
|
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:
| false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
This endpoint does not have response elements.
Example Request¶
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/whitelist/192.0.2.0%2F24" \
Example Response¶
This endpoint does not return a response body.