This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Add Entries to a Whitelist


Personal API Keys are deprecated; use Programmatic API Keys instead.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0


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 Description Default
pageNum number One-based integer that returns a subsection of results. 1
itemsPerPage number Number of items to return per page, up to a maximum of 500. 100
pretty boolean Flag that indicates whether the response body should be in a prettyprint format. false
envelope boolean

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. Ops Manager adds the status field to the response body.


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, Ops Manager does not store the /32, as the /32 does not change the address.


An address of is the same as

Parameter Type Description
IP-ADDRESS string (Required.) The IP address that you want to add to the specified user’s whitelist.


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

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request POST "https://<ops-manager-host>/api/public/v1.0/users/{USER-ID}/whitelist"    --data '
   [ {
       "ipAddress" : ""
     }, {
       "ipAddress" : ""
   } ]'

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

  "totalCount" : 3,
  "results" : [ {
    "cidrBlock" : "",
    "ipAddress" : "",
    "created" : "2014-04-23T16:17:44Z",
    "lastUsed" : "2016-08-17T19:34:05Z",
    "lastUsedAddress" : "",
    "count" : 0,
    "links" : []
  }, {
    "cidrBlock" : "",
    "ipAddress" : "",
    "created" : "2016-08-17T19:34:05Z",
    "count" : 0,
    "links" : []
  }, {
    "cidrBlock" : "",
    "ipAddress" : "",
    "created" : "2016-08-17T19:34:05Z",
    "count" : 0,
    "links" : []
  } ],
  "links" : []