Add Entries to a Whitelist¶

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

Resource¶

POST /users/{USER-ID}/whitelist

Request Path Parameters¶

Parameter	Type	Description
USER-ID	string	(Required.) Unique identifier of the current user. To retrieve the ID of the current user, see Get All Users in One Project.

Request Query Parameters¶

The following query parameters are optional:

Name	Type	Necessity	Description	Default
pageNum	number	Optional	One-based integer that returns a subsection of results.	`1`
itemsPerPage	number	Optional	Number of items to return per page, up to a maximum of 500.	`100`
pretty	boolean	Optional	Flag that indicates whether the response body should be in a prettyprint format.	`false`
envelope	boolean	Optional	Flag that 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 a list of results, the `results` object is an envelope. Cloud Manager adds the `status` field to the response body.	`false`

Request Body Parameters¶

The request body must be an array of whitelist entities, even if there is only one. The only field that you need to specify for each request object is the IP-ADDRESS.

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

If you specify a single IP address with the /32 subnet mask, Cloud Manager does not store the /32, as the /32 does not change the address.

Example

An address of 12.34.56.78 is the same as 12.34.56.78/32.

Parameter	Type	Description
ipAddress	string	(Required.) The IP address or CIDR block that you want to add to the specified user’s whitelist.

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`	array	Array includes one object for each item detailed in the results Embedded Document section.
`links`	array	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	Integer 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 result is one whitelist.

Name	Type	Description
`cidrBlock`	string	A CIDR-notated range of IP addresses.
`created`	date	The date this IP address was added to the whitelist.
`ipAddress`	string	A whitelisted IP address.
`lastUsed`	date	The date of the most recent request that originated from this IP address. Note that this field is only updated when a whitelisted resource is accessed.
`lastUsedAddress`	string	The address from which the last call to the API was issued.
`count`	number	The total number of requests that originated from this IP address. Note that this field is only updated when a resource that is protected by the whitelist is accessed.
`links`	array	Links to related sub-resources. All links arrays in responses contain at least one link called `self`. The relations between URLs are explained in the Web Linking Specification.

Example Request¶

copy

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/users/{USER-ID}/whitelist" --data '
    [
      {
        "ipAddress" : "192.0.1.15",
        "comment" : "IP address for Application Server A"
      },
      {
        "cidrBlock" : "192.0.2.0/24",
        "comment" : "CIDR block for Application Server B - D"
      }
    ]'

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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body¶