Navigation

Add Entries to a Whitelist

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

Resource

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

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 ipAddress.

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. For example, an address of 12.34.56.78 is the same as 12.34.56.78/32.

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

An array including one or more of the following elements:

Parameter Required/Optional Description
ipAddress Required The IP address that you want to add to the specified user’s whitelist.

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" -H "Content-Type: application/json" --digest -X POST "https://<ops-manager-host>/api/public/v1.0/users/5356823b3004dee37132bb7b/whitelist" --data '
[ {
    "ipAddress" : "76.54.32.10"
  }, {
    "ipAddress" : "2.3.4.5"
} ]'

Example Response

HTTP/1.1 201 Created

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