Navigation

Get One Whitelist Entry for One IP or CIDR Block (Deprecated)

Info With Circle IconCreated with Sketch.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 With Circle IconCreated with Sketch.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.
Info With Circle IconCreated with Sketch.Note

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

The following retrieves the whitelist entry that contains an IP address or a CIDR block.

Replace the forward slash (/) in the CIDR -notated address range with %2F.

Beaker IconExample

Type 1.2.3.4%2F16 for 1.2.3.4/16.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

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

GET /users/{USER-ID}/whitelist/({IP-ADDRESS}|{CIDR-BLOCK})
Path ParameterTypeNecessityDescription
USER-IDstringRequired

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.

NameTypeNecessityDescriptionDefault
pageNumintegerOptionalPage number, starting with one, that Atlas returns of the total number of objects.1
itemsPerPageintegerOptionalNumber of items that Atlas returns per page, up to a maximum of 500.100
includeCountbooleanOptionalFlag that indicates whether Atlas returns the totalCount parameter in the response body.true
prettybooleanOptionalFlag that indicates whether Atlas returns the JSON response in the prettyprint format.false
envelopebooleanOptional

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.

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

NameTypeDescription
resultsarray of objectsOne object for each item detailed in the results Embedded Document section.
linksarray of objectsOne or more links to sub-resources and/or related resources. The relations between URL s are explained in the Web Linking Specification
totalCountintegerCount of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
NameTypeDescription
cidrBlockstringCIDR -notated range of IP addresses.
createdstringTimestamp in ISO 8601 date and time format in UTC when this IP address was added to the whitelist.
ipAddressstringWhitelisted IP address.
lastUsedstring

Timestamp in ISO 8601 date and time format in UTC when the most recent request that originated from this IP address.

Info With Circle IconCreated with Sketch.Note

Atlas updates this parameter when it accesses an API resource that the whitelist protects.

lastUsedAddressstringLast call to the API was issued from this address.
countinteger

Total number of requests that originated from this IP address.

Info With Circle IconCreated with Sketch.Note

Atlas updates this parameter when it accesses an API resource that the whitelist protects.

1curl --user "{publicApiKey}:{privateApiKey}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request GET "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 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
1{
2 "cidrBlock" : "12.34.56.78/32",
3 "ipAddress" : "12.34.56.78",
4 "created" : "2016-08-18T16:17:44Z",
5 "count" : 4,
6 "links" : [ ]
7}
Give Feedback