Navigation

Delete an Entry from the Project IP Whitelist

Access List Replaces 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.

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.

Important

The /groups/{PROJECT-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.

Base URL: 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:

  • AWS security group ID,
  • IP address, or
  • CIDR address

of the whitelist entry to delete. If the entry includes a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.

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:

  • how the connection was established
  • how the application or driver using the address behaves
  • which protocol (like TCP or UDP) the connection uses

Request Query Parameters

The following query parameters are optional:

Query Parameter Type Description Default
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. 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.