Get Project IP Whitelist¶
Atlas now refers to its cluster firewall management as IP Access Lists. Atlas has deprecated the whitelist resource and will disable it in June 2021. Revise your whitelist endpoints to use the IP Access List resource.
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
.
The /groups/{PROJECT-ID}/whitelist
endpoint manages the
Project IP Whitelist. This endpoint is
distinct from the
/users/{USER-ID}/whitelist
endpoint, which manages an Atlas user's
API whitelist.
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.
https://cloud.mongodb.com/api/atlas/v1.0
Syntax¶
GET /groups/{GROUP-ID}/whitelist
Request Path Parameters¶
Path Element | Required/Optional | Description |
---|---|---|
GROUP-ID | Required. | The unique identifier for the project from which you want to retrieve whitelist entries. |
Request Query Parameters¶
The following query parameters are 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 Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
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.
Name | Type | Description |
---|---|---|
results | object array | Includes one object for each item detailed in the results array section. |
links | object array | Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount | number | Count 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. |
results
array¶
Each element in the result
array is one whitelist entry associated
to the project IP whitelist.
Name | Type | Description |
---|---|---|
awsSecurityGroup | string | ID of the whitelisted AWS security group. Mutually exclusive
with cidrBlock and ipAddress . |
cidrBlock | string | Whitelist entry in Classless Inter-Domain Routing (CIDR)
notation. Mutually exclusive with awsSecurityGroup and
ipAddress . |
ipAddress | string | Whitelisted IP address. Mutually exclusive with awsSecurityGroup and cidrBlock . |
groupId | string | ID of the project containing the whitelist entry. |
comment | string | Comment associated with the whitelist entry. |
deleteAfterDate | date | ISO-8601- formatted date after which Atlas deletes the temporary whitelist entry. This field is only present if an expiration date was specified when creating the entry. |
links | object array | Includes a link to the whitelist entry, including the HTML-escaped IP or CIDR address. |
Example Request¶
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist?pretty=true"
Example Response¶
{ "links": [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist?pageNum=1&itemsPerPage=100?pretty=true", "rel": "self" } ], "results": [ { "cidrBlock": "192.0.2.0/24", "comment": "IP address for Application Server A", "groupId": "5aec7afbf7d068e35a39809b", "ipAddress": "192.0.2.15", "links": [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist/192.0.2.15%2F24", "rel": "self" } ] }, { "cidrBlock": "203.0.113.0/24", "comment": "CIDR block for Application Server B - D", "groupId": "5aec7afbf7d068e35a39809b", "links": [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist/203.0.113.0%2F24", "rel": "self" } ] }, { "awsSecurityGroup": "sg-0026348ec11780bd1", "comment": "Whitelisted AWS Security Group", "groupId": "5aec7afbf7d068e35a39809b", "links": [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5aec7afbf7d068e35a39809b/whitelist/sg-0026348ec11780bd1", "rel": "self" } ] ], "totalCount": 3 }