Delete One Whitelist Entry for an API Key¶

On this page

Resource
Response
Example Request
Example Response

Delete a specified whitelisted address from the specified API Key.

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.
`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 Atlas 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 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 envelope=true in the query.

For endpoints that return one result, response body includes:

`status`	HTTP response code
`envelope`	The expected response body

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

This endpoint returns an empty JSON document.

Example Request¶

copy

curl --user "{USERNAME}:{APIKEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/147.58.184.16"

Example Response¶

HTTP/1.1 204 No Content

← Update an API Key Delete One API Key →