This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.
This version of the manual is no longer supported.

Delete One Entry from One Whitelist


Personal API Keys are deprecated; use Programmatic API Keys instead.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0


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


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.
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 Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean

Flag indicating 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

Request Body Parameters

This endpoint does not use HTTP request body parameters.


This endpoint does not have response elements.

Example Request

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --include \
 --request DELETE "https://<ops-manager-host>/api/public/v1.0/users/{USER-ID}/whitelist/"

Example Response

This endpoint does not return a response body.