Add Entries to One User's Whitelist (Deprecated)¶

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

Atlas deprecated Personal API keys

You can't create new Personal API Keys.
You can't access the API using your existing Personal API Keys starting March 1, 2021.
You must update any existing scripts or tools to use Programmatic API Keys instead.

Note

Don't confuse this resource with the Project IP Access List resource. That resource controls client access to the project's MongoDB clusters.

Use the following resource to create an entry in your API whitelist.

Atlas whitelists this endpoint. It must originate from an address already on your 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.

Resource¶

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

POST /users/USER-ID/whitelist

The entity body must be an array of objects, even if it contains only one object. Each object should specify either the cidrBlock field or ipAddress field, but not both.

If an address is already in the whitelist, it will be ignored.

If you specify a single IP address with the /32 subnet mask, Atlas does not store the /32, as the /32 does not change the address. For example, an address of 12.34.56.78 is the same as 12.34.56.78/32.

Request Parameters¶

Request Path Parameters¶

Path Parameter	Type	Necessity	Description
USER-ID	string	Required	Unique 24-hexdecimal-digit string that identifies your Atlas user. To retrieve user IDs, see Get All Users in One Project. Your user ID corresponds to the id field returned in the response from that endpoint.

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	Necessity	Description	Default
pageNum	integer	Optional	Page number, starting with one, that Atlas returns of the total number of objects.	`1`
itemsPerPage	integer	Optional	Number of items that Atlas returns per page, up to a maximum of 500.	`100`
includeCount	boolean	Optional	Flag that indicates whether Atlas returns the totalCount parameter in the response body.	`true`
pretty	boolean	Optional	Flag that indicates whether Atlas returns the JSON response in the prettyprint format.	`false`
envelope	boolean	Optional	Flag that indicates whether Atlas wraps 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. Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.	`false`

Request Body Parameters¶

Name	Type	Necessity	Description
cidrBlock	string	Optional	CIDR-notated range of IP addresses. Use cidrBlock or ipAddress, not both.
ipAddress	string	Optional	Whitelisted IP address. Use cidrBlock or ipAddress, not both.

Response¶

Name	Type	Description
cidrBlock	string	CIDR-notated range of IP addresses.
created	string	Timestamp in ISO 8601 date and time format in UTC when this IP address was added to the whitelist.
ipAddress	string	Whitelisted IP address.
lastUsed	string	Timestamp in ISO 8601 date and time format in UTC when the most recent request that originated from this IP address. Note Atlas updates this parameter when it accesses an API resource that the whitelist protects.
lastUsedAddress	string	Last call to the API was issued from this address.
count	integer	Total number of requests that originated from this IP address. Note Atlas updates this parameter when it accesses an API resource that the whitelist protects.

Example Request¶

1 curl --user "{publicApiKey}:{privateApiKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://cloud.mongodb.com/api/atlas/v1.0/users/{USER-ID}/whitelist" \
6      --data '
7             [ {
8                 "ipAddress" : "76.54.32.10"
9               }, {
10                 "ipAddress" : "2.3.4.5"
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 201 Created
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   "results" : [ {
3     "cidrBlock" : "12.34.56.78/32",
4     "ipAddress" : "12.34.56.78",
5     "created" : "2016-08-18T16:17:44Z",
6     "lastUsed" : "2016-08-23T19:34:05Z",
7     "lastUsedAddress" : "12.34.56.78",
8     "count" : 5,
9     "links" : [  ]
10   }, {
11     "cidrBlock" : "76.54.32.10/32",
12     "ipAddress" : "76.54.32.10",
13     "created" : "2016-08-17T19:34:05Z",
14     "count" : 0,
15     "links" : [  ]
16   }, {
17     "cidrBlock" : "2.3.4.5/32",
18     "ipAddress" : "2.3.4.5",
19     "created" : "2016-08-17T19:34:05Z",
20     "count" : 0,
21     "links" : [  ]
22   } ],
23   "totalCount" : 3,
24   "links" : [  ]
25 }

Give Feedback

← Get One Whitelist Entry for One IP or CIDR Block (Deprecated)Delete One Entry from One User's API Whitelist (Deprecated) →

1	curl --user "{publicApiKey}:{privateApiKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://cloud.mongodb.com/api/atlas/v1.0/users/{USER-ID}/whitelist" \
6	--data '
7	[ {
8	"ipAddress" : "76.54.32.10"
9	}, {
10	"ipAddress" : "2.3.4.5"
11	} ]'

1	{
2	"results" : [ {
3	"cidrBlock" : "12.34.56.78/32",
4	"ipAddress" : "12.34.56.78",
5	"created" : "2016-08-18T16:17:44Z",
6	"lastUsed" : "2016-08-23T19:34:05Z",
7	"lastUsedAddress" : "12.34.56.78",
8	"count" : 5,
9	"links" : [ ]
10	}, {
11	"cidrBlock" : "76.54.32.10/32",
12	"ipAddress" : "76.54.32.10",
13	"created" : "2016-08-17T19:34:05Z",
14	"count" : 0,
15	"links" : [ ]
16	}, {
17	"cidrBlock" : "2.3.4.5/32",
18	"ipAddress" : "2.3.4.5",
19	"created" : "2016-08-17T19:34:05Z",
20	"count" : 0,
21	"links" : [ ]
22	} ],
23	"totalCount" : 3,
24	"links" : [ ]
25	}