- API >
- Public API Resources >
- Programmatic API Keys >
- Global Programmatic API Key Whitelists >
- Create One Global Whitelist Entry
Create One Global Whitelist Entry¶
On this page
Create one Global Whitelist Entry for Ops Manager.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Required Roles¶
Requires that the API Key calling this endpoint have the
Global Owner
role.
Request Parameters¶
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
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¶
Specify a document that represents one whitelist entry you want to add.
When you submit a POST
request containing a cidrBlock
value which is not already present in the whitelist,
Ops Manager adds those entries to the list of existing entries in the
whitelist. Ops Manager does not set the whitelist to only contain the
entries specified in the request.
Name | Type | Necessity | Description |
---|---|---|---|
description |
string | Required | Description of the Global Whitelist Entry. Must be between 1 and 250 characters in length. |
cidrBlock |
string | Required | Whitelist entry in IPv4 or IPv6 CIDR notation to be added. |
Response¶
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. |