Navigation

Add Entries to Project IP Whitelist

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/{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 uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

Syntax

POST /groups/{GROUP-ID}/whitelist

Request Path Parameters

Path Element Required/Optional Description
GROUP-ID Required. The unique identifier for the project to which you want to add one or more whitelist entries.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100
pretty boolean Display response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

Specify an array of documents, where each document represents one whitelist entry you want to add to the project. You must specify an array even if you are only associating a single whitelist entry to the project.

When you submit a POST request containing ipAddress or cidrBlock values which are not already present in the whitelist, Atlas adds those entries to the list of existing entries in the whitelist. Atlas does not set the whtelist to only contain the entries specified in the request.

Name Type Description
cidrBlock string The whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with ipAddress.
ipAddress string The whitelisted IP address. Mutually exclusive with cidrBlock.
comment string Optional The comment associated with the whitelist entry.
deleteAfterDate date

Optional The ISO-8601-formatted UTC date after which Atlas removes the entry from the whitelist. The specified date must be in the future and within one week of the time you make the API request.

Important

You cannot set AWS security groups as temporary whitelist entries.

Note

You may include an ISO-8601 time zone designator to ensure that the expiration date occurs with respect to the local time in the specified time zone.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.

Name Type Description
results object array This array includes one object for each item detailed in the results array section.
links object array This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results array

Each element in the result array is one whitelist entry associated to the project IP whitelist.

Name Type Description
cidrBlock string The whitelist entry in Classless Inter-Domain Routing (CIDR) notation.
ipAddress string The whitelisted IP address. Only present for entries not created using CIDR notation.
groupId string ID of the project containing the whitelist entry.
comment string The comment associated with the whitelist entry.
deleteAfterDate date The ISO-8601- formatted date after which Atlas deletes the temporary whitelist entry. This field is only present for if an expiration date was specified when creating the entry.
links object array This array includes a link to the whitelist entry, including the HTML-escaped IP or CIDR address.

Example Request

curl --user "{USERNAME}:{APIKEY}" --digest --include \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist?pretty=true" \
  --data '
    [
      {
        "ipAddress" : "192.0.2.15",
        "comment" : "IP address for Application Server A"
      },
      {
        "cidrBlock" : "203.0.113.0/24",
        "comment" : "CIDR block for Application Server B - D"
      }
    ]'

Example Response

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist?pageNum=1&itemsPerPage=100?pretty=true",
      "rel": "self"
    }
  ],
  "results": [
    {
      "cidrBlock": "192.0.2.0/24",
      "comment": "IP address for Application Server A",
      "groupId": "5aec7afbf7d068e35a39809b",
      "ipAddress": "192.0.2.15",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist/192.0.2.15%2F24",
          "rel": "self"
        }
      ]
    },
    {
      "cidrBlock": "203.0.113.0/24",
      "comment": "CIDR block for Application Server B - D",
      "groupId": "5aec7afbf7d068e35a39809b",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist/203.0.113.0%2F24",
          "rel": "self"
        }
      ]
    }
  ],
  "totalCount": 2
}