- API >
- Public API Resources >
- Groups and Users >
- Whitelist >
- Add Entries to a Whitelist
Add Entries to a Whitelist¶
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 a Group. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pageNum | integer | Page number (1-based). | 1 |
itemsPerPage | integer | Maximum number of items to return, up to a maximum of 100. | 100 |
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 a list of results, the |
false |
Request Body Parameters¶
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 IP-ADDRESS.
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.
Example
An address of 12.34.56.78
is the same as 12.34.56.78/32
.
Parameter | Type | Description |
---|---|---|
IP-ADDRESS | string | (Required.) The IP address that you want to add to the specified user’s whitelist. |
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results | object array | This array includes one object for each item detailed in the results Embedded Document section. |
links | object array | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount | number | The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result is one whitelist.
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. |