- API >
- Public API Resources >
- API Keys >
- Delete One Whitelist Entry for an API Key
Delete One Whitelist Entry for an API Key¶
On this page
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Delete a specified whitelisted address from the specified API Key.
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
ORG-ID |
string | Unique identifier for the organization to which the target API key belongs. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
API-KEY-ID |
string | Unique identifier for the API key for which you want to retrieve whitelist entries. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys for the specified organization to which the authenticated user has access. |
IP-ADDRESS |
string | IP address or CIDR block to delete. If the entry includes a
subnet mask, use the URL-encoded value %2F for the forward
slash / . |
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 | Number of items to return per page, up to a maximum of 500. | 100 |
||||
pretty |
boolean | Indicates whether the response body should be in a prettyprint format. | false |
||||
envelope |
boolean | 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 For endpoints that return one result, response body includes:
For endpoints that return a list of results, the |
None |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
This endpoint returns an empty JSON document.