Navigation

Get Whitelist for an IP Address

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

Resource

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

Retrieves a whitelist entity if the value of IP-ADDRESS equals the value of the entity’s ipAddress field. This does not retrieve an object where the value of IP-ADDRESS is contained within the values allowed by the cidrBlock field.

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.
IpAddress Required IP Address for which you want to retrieve a whitelist.

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 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/12.34.56.78"

Example Response

HTTP/1.1 200 OK

{
  "cidrBlock" : "12.34.56.78/32",
  "ipAddress" : "12.34.56.78",
  "created" : "2014-04-23T16:17:44Z",
  "count" : 482,
  "links" : [ ... ]
}