Navigation

Delete One Entry from One User's API Whitelist (Deprecated)

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Important
Atlas deprecated Personal API keys
  • You can't create new Personal API Keys.
  • You can't access the API using your existing Personal API Keys starting March 1, 2021.
  • You must update any existing scripts or tools to use Programmatic API Keys instead.
Note

Don't confuse this resource with the Project IP Access List resource. That resource controls client access to the project's MongoDB clusters.

Use the following resource to remove an entry in your API whitelist.

Atlas whitelists this endpoint. It must originate from an address already on your API whitelist.

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

/users/{USER-ID}/whitelist/({IP-ADDRESS} | {CIDR-BLOCK})

Replace the forward slash (/) in the CIDR-notated address range with %2F. For example, specify 1.2.3.4%2F16``for ``1.2.3.4/16.

You cannot remove your current IP address from the whitelist.

Path Parameter
Type
Necessity
Description
USER-ID
string
Required

Unique 24-hexdecimal-digit string that identifies your Atlas user.

To retrieve user IDs, see Get All Users in One Project. Your user ID corresponds to the id field returned in the response from that endpoint.

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, starting with one, that Atlas returns of the total number of objects.
1
itemsPerPage
integer
Optional
Number of items that Atlas returns per page, up to a maximum of 500.
100
includeCount
boolean
Optional
Flag that indicates whether Atlas returns the totalCount parameter in the response body.
true
pretty
boolean
Optional
Flag that indicates whether Atlas returns the JSON response in the prettyprint format.
false
envelope
boolean
Optional

Flag that indicates whether Atlas wraps 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.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

false

This endpoint doesn't use HTTP request body parameters.

This endpoint does not have response elements.

curl --user "{publicApiKey}:{privateApiKey}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--include \
--request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/users/{USER-ID}/whitelist/192.0.2.0%2F24"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 204 No Content
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

This endpoint returns an empty JSON object.

Give Feedback

On this page

  • Resource
  • Request Parameters
  • Response
  • Example Request
  • Example Response