Navigation

Create Whitelist Entries for One Organization API Key

On this page

Create one or more new whitelist entries for the specified API Key.

All requests to this endpoint must originate from an IP address on the Atlas user’s API whitelist. For complete documentation on configuring API whitelists, see Enable API Whitelisting for Your Organization.

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

Resource

copy 
POST /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist

Request Path Parameters

Name Type Description
ORG-ID string Unique identifier for the organization to which the target API Key belongs. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
API-KEY-ID string Unique identifier for the Organization API Key for which you want to create a new whitelist entry.

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 Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
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 envelope=true in the query.

For endpoints that return one result, response body includes:

status HTTP response code
envelope The expected response body

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

  

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 whitelist to only contain the entries specified in the request.

Note

Atlas supports up to 500 API Keys within a single organization.

In the following table, [i] represents an array index.

Name Type Description
[i].ipAddress string IP address to be added to the whitelist for the API key. This field is mutually exclusive with the cidrBlock field.
[i].cidrBlock string Whitelist entry in CIDR notation to be added for the API key. This field is mutually exclusive with the ipAddress field.

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 Embedded Document 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 Embedded Document

Each object within the results array is one whitelist entry.

Name Type Description
cidrBlock string CIDR-notated range of whitelisted IP addresses.
count number Total number of requests that have originated from this IP address.
created date Date this IP address was added to the whitelist.
ipAddress string Whitelisted IP address.
lastUsed date Date of the most recent request that originated from this IP address. This field only appears if at least one request has originated from this IP address, and is only updated when a whitelisted resource is accessed.
lastUsedAddress string IP address from which the last call to the API was issued. This field only appears if at least one request has originated from this IP address.
links array An array of documents, representing a link to one or more sub-resources and/or related resources such as list pagination. See Linking for more information.

Example Request

copy 
1
2
3
4
5
6
7
8
9
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--include \
--request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist?pretty=true" \
--data '
  [{
      "ipAddress" : "77.54.32.11"
   }]'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "cidrBlock" : "206.252.195.126/32",
    "count" : 47,
    "created" : "2019-01-24T16:26:37Z",
    "ipAddress" : "206.252.195.126",
    "lastUsed" : "2019-01-25T16:32:47Z",
    "lastUsedAddress" : "206.252.195.126",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/206.252.195.126",
      "rel" : "self"
    } ]
  }, {
    "cidrBlock" : "76.54.32.11/32",
    "count" : 0,
    "created" : "2019-01-24T21:09:05Z",
    "ipAddress" : "76.54.32.11",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/76.54.32.11",
      "rel" : "self"
    } ]
  }, {
    "cidrBlock" : "77.54.32.11/32",
    "count" : 0,
    "created" : "2019-01-25T16:32:47Z",
    "ipAddress" : "77.54.32.11",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/77.54.32.11",
      "rel" : "self"
    } ]
  } ],
  "totalCount" : 3
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.