- API >
- Public API Resources >
- Programmatic API Keys >
- Global Programmatic API Key Whitelists >
- Get One Global Whitelist Entry
Get One Global Whitelist Entry¶
On this page
Return one Global Whitelist Entry using the unique identifier for the desired whitelisted address.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
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 | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope | boolean | Optional | Flag that indicates 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:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
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. |