- API >
- Public API Resources >
- Projects and Users >
- Whitelist (Deprecated) >
- Get Whitelist for an IP Address
Get Whitelist for an IP Address¶
On this page
Important
Personal API Keys are deprecated; use Programmatic API Keys instead.
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.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Parameter | Type | Description |
---|---|---|
USER-ID | string | (Required.) Unique identifier of the current user. To retrieve the ID of the current user, see Get All Users in One Project. |
IP-ADDRESS | string | (Required.) IP Address for which you want to retrieve a whitelist. |
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 For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description |
---|---|---|
cidrBlock |
string | A CIDR-notated range of IP addresses. |
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. |