Get Single Project IP Whitelist Entry

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.


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/{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:


GET /groups/{GROUP-ID}/whitelist/{WHITELIST-ENTRY}

Request Path Parameters

Path Element Required/Optional Description
GROUP-ID Required. The unique identifier for the project from which you want to retrieve a whitelist entry.

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, use the URL-encoded value %2F for the forward slash /.

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.


Name Type Description
awsSecurityGroup string ID of the whitelisted AWS security group. Mutually exclusive with cidrBlock and ipAddress.
cidrBlock string Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with awsSecurityGroup and ipAddress.
ipAddress string Whitelisted IP address. Mutually exclusive with awsSecurityGroup and cidrBlock.
groupId string ID of the project containing the whitelist entry.
comment string Comment associated with the whitelist entry.
deleteAfterDate date ISO-8601- formatted date after which Atlas deletes the temporary whitelist entry. This field is only present if an expiration date was specified when creating the entry.
links object array Includes a link to the whitelist entry, including the HTML-escaped IP or CIDR address.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET ""

Example Response

  "cidrBlock": "",
  "comment": "CIDR block for Application Server B - D",
  "groupId": "5aec7afbf7d068e35a39809b",
  "links": [
      "href": "",
      "rel": "self"