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.

Get Whitelist for the Current User

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


GET /users/{USER-ID}/whitelist

Request Path Parameters

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

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Ops Manager 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 a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.


Request Body Parameters

This endpoint does not use HTTP request body parameters.


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 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. Entering gives unrestricted access to whitelisted operations.
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 "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/users/{USER-ID}/whitelist"

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

  "results" : [ {
    "cidrBlock" : "",
    "count" : 482,
    "created" : "2014-04-23T16:17:44Z",
    "lastUsed" : "2016-04-19T14:15:52Z",
    "lastUsedAddress" : "",
    "links" : []
  }, {
    "cidrBlock" : "",
    "count" : 9,
    "created" : "2016-02-19T14:46:14Z",
    "ipAddress" : "",
    "lastUsed" : "2016-04-25T15:42:50Z",
    "lastUsedAddress" : "",
    "links" : []
  } ],
  "totalCount" : 2,
  "links" : []