Delete One Entry from One Whitelist¶

On this page

Resource
Response
Example Request
Example Response

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

Resource¶

DELETE /users/{USER-ID}/whitelist/{WHITELIST-ENTRY}

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 One Project.
`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¶

The following query parameters are optional:

Name Type Necessity Description Default

pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false

envelope

boolean

Optional

Flag that 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:

Name	Description
status	HTTP response code
envelope	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/192.0.2.0%2F24"

Example Response¶

This endpoint does not return a response body.

← Add Entries to a Whitelist Programmatic API Keys →

Cloud Manager will no longer support Automation for MongoDB 3.4 clusters after February 10, 2022. Please upgrade your MongoDB deployment or migrate to Atlas.