Delete One Whitelist Entry for One Organization API Key¶
Delete a specified whitelisted address from the specified API Key.
All requests to this endpoint must originate from an IP address in the organization's API access list.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
DELETE /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/{IP-ADDRESS}
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. |
WHITELIST-ENTRY | string | The IP or CIDR address.
If the entry includes a subnet mask, such as 192.0.2.0/24,
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 Atlas API resources. These are all optional.
| Name | Type | Necessity | Description | Default | ||||
|---|---|---|---|---|---|---|---|---|
| pageNum | integer | Optional | Page number (1-based). | 1 | ||||
| itemsPerPage | integer | Optional | Maximum number of items to return, up to a maximum of 100. | 100 | ||||
includeCount | boolean | Optional | Specifies whether the response returns the totalCount field. | true | ||||
| pretty | boolean | Optional | Indicates whether the response body should be in a prettyprint format. | false | ||||
| envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON 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:
For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body. | false |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response¶
This endpoint returns an empty JSON document.
Example Request¶
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/192.0.2.0%2F24"
Example Response¶
HTTP/1.1 204 No Content