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.
This version of the manual is no longer supported.

Get All Whitelist Entries for a Global API Key

Return all Global Whitelist Entries for Ops Manager.

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


GET /admin/whitelist

Required Roles

Requires that the API Key calling this endpoint have the Global Read Only role.

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

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

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 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 Global Whitelist Entry.

Name Type Description
cidrBlock string Range of whitelisted IP addresses in IPv4 or IPv6 CIDR notation.
created string Timestamp, in the number of seconds that have elapsed since the UNIX epoch when you added this CIDR block to the Global Whitelist.
description string Explanation of the purpose of this Global Whitelist Entry.
id string Unique identifier for this Global Whitelist Entry.
type string Scope of the Global Whitelist Entry.
updated string Timestamp, in the number of seconds that have elapsed since the UNIX epoch when you last changed the CIDR block of this Global Whitelist Entry.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/whitelist?pretty=true"

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

Response Body

  "results" : [ {
    "cidrBlock" : "",
    "created" : "2019-09-05T04:02:46Z",
    "description" : "Test Global Whitelist Entry 1",
    "id" : "5d4d7b9cf20ce440466a30bd",
    "type" : "GLOBAL_ROLE",
    "updated" : "2019-09-05T04:02:46Z"
  }, {
    "cidrBlock" : "2001:db8::/48",
    "created" : "2019-09-05T04:02:46Z",
    "description" : "Test Global Whitelist Entry 2",
    "id" : "5d6fe33787d9d6689b3427ec",
    "type" : "GLOBAL_ROLE",
    "updated" : "2019-09-05T04:02:46Z"
  } ]
  "totalCount" : 2