Delete One Entry from One Whitelist¶

On this page

Resource
Response
Example Request
Example Response

Important

Personal API Keys are deprecated; use Programmatic API Keys instead. You cannot create new Personal API Keys, but existing Personal API Keys continue to function.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource¶

copy

DELETE /users/{USER-ID}/whitelist/{IP-ADDRESS}

copy

DELETE /users/{USER-ID}/whitelist/{CIDR-BLOCK}

Note

You cannot remove your current IP address from the whitelist.

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.
IP-ADDRESS	Required. unless you specify a CIDR-BLOCK.	A whitelisted IP address that you want to remove from the whitelist for the specified user.
CIDR-BLOCK	Required. unless you specify an IP-ADDRESS.	A CIDR-notated range of IP addresses.

Request Query Parameters¶

The following query parameters are optional:

Name Type Description Default

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, the response body includes:

status: HTTP response code
envelope: The expected response body

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

This endpoint does not have response elements.

Example Request¶

copy

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --include \
 --request DELETE "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/whitelist/2.3.4.5"

Example Response¶

This endpoint does not return a response body.

← Add Entries to a Whitelist Personal API Keys (Deprecated) →