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

Return one Global Whitelist Entry using the unique identifier for the desired whitelisted address.

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


GET /admin/whitelist/{WHITELIST-ID}

Required Roles

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

Request Parameters

Request Path Parameters

Name Type Description
WHITELIST-ID string Unique identifier for the Global Whitelist Entry.

Request Query Parameters

The following query parameters are optional:

Name Type Description Default
pretty boolean Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean

Flag indicating 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 one result, the response body includes:

Name Description
status HTTP response code
envelope Expected response body

Request Body Parameters

This endpoint does not use HTTP request body parameters.


Response Elements

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 "{USERNAME}:{APIKEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/whitelist/{WHITELIST-ID}?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

  "cidrBlock" : "",
  "created" : "2019-09-05T04:02:46Z",
  "description" : "Test Global Whitelist Entry 1",
  "id" : "5d6fe33787d9d6689b3427ec",
  "type" : "GLOBAL_ROLE",
  "updated" : "2019-09-05T04:02:46Z"