Navigation

Get Whitelist for the Current User

Base URL: https://<ops-manager-host>/

Resource

GET /api/public/v1.0/users/{USER-ID}/whitelist

Request Path Parameters

Parameter Required/Optional Description
userId Required User ID of the current user. To retrieve the ID of the current user, see Get All Users in a Group.

Request Query Parameters

This endpoint does not use HTTP request query parameters.

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

The response includes the totalCount of the whitelist entries and a results array with a document for each entry in the specified user’s whitelist. Each result document contains the following elements:

Name Type Description
cidrBlock string A CIDR-notated range of IP addresses. Entering 0.0.0.0/0 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 -i -u "username:apiKey" --digest "https://<ops-manager-host>/api/public/v1.0/users/5356823b3004dee37132bb7b/whitelist"

Example Response

HTTP/1.1 200 OK

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