Navigation

Add Entries to Project IP Access List

Important With Circle IconCreated with Sketch.Important
Access List Replaces Whitelist

This resource replaces the whitelist resource. Atlas deprecated whitelists. The whitelist resource will be disabled in June 2021. Consider updating your applications to use this new resource.

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

The /groups/{PROJECT-ID}/accessList endpoint manages the database IP access list. This endpoint differs from the /users/{USER-ID}/whitelist endpoint, which manages an Atlas user's API whitelist.

This endpoint does not support concurrent POST requests. Multiple POST requests must be submitted synchronously.

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

POST /groups/{PROJECT-ID}/accessList
ParameterTypeNecessityDescription
PROJECT-IDstringRequiredUnique identifier for the project to which you want to add one or more Access List entries.

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

Specify an array of documents, where each document represents one Access List entry you want to add to the project. You must specify an array even if you add a single Access List entry to the project.

Important With Circle IconCreated with Sketch.Important
How Access List Updates Work

The Access List might change depending upon what you submit in the POST request. This request attempts to find an existing Access List entry that has the same awsSecurityGroup, ipAddress, or cidrBlock value. If the Access List entry:

Access List Entry Matchcomment ValueAccess List Update
YesUnchangedMakes no change.
NoAddedAppends request as new Access List entry.
YesChangedUpdates comment value in Access List entry with matching awsSecurityGroup, ipAddress, or cidrBlock value.
ParameterTypeNecessityDescription
awsSecurityGroupstringConditional

Unique identifier of the AWS security group to add to the access list.

Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.

Info With Circle IconCreated with Sketch.Note

You must configure VPC peering for your project before you can add an AWS security group to an access list.

cidrBlockstringConditional

Range of IP addresses in CIDR notation to be added to the access list.

Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.

commentstringOptionalComment associated with the access list entry.
deleteAfterDatedateOptional

Timestamp in ISO 8601 date and time format in UTC after which Atlas removes the entry from the access list. The specified date must be in the future and within one week of the time you make the API request.

Important With Circle IconCreated with Sketch.Important

You cannot set AWS security groups as temporary access list entries.

Info With Circle IconCreated with Sketch.Note

You may include an ISO 8601 time zone designator to ensure that the expiration date occurs with respect to the local time in the specified time zone.

ipAddressstringConditional

Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.

Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.

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.

Each element in the result array is one Access List entry associated to the project IP Access List.

NameTypeDescription
awsSecurityGroupstringUnique identifier of AWS security group in this access list entry.
cidrBlockstringRange of IP addresses in CIDR notation in this access list entry.
commentstringComment associated with this access list entry.
deleteAfterDatedateTimestamp in ISO 8601 date and time format in UTC after which Atlas deletes the temporary access list entry. Atlas returns this field if you specified an expiration date when creating this access list entry.
groupIdstringUnique identifier of the project to which this access list entry applies.
ipAddressstringEntry using an IP address in this access list entry.
linksobject arrayOne or more links to sub-resources and/or related resources. The relations between URL s are explained in the Web Linking Specification
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/accessList?pretty=true" \
--data '
[
{
"ipAddress" : "192.0.2.15",
"comment" : "IP address for Application Server A"
},
{
"cidrBlock" : "203.0.113.0/24",
"comment" : "CIDR block for Application Server B - D"
},
{
"awsSecurityGroup" : "sg-0026348ec11780bd1",
"comment" : "Access Listed AWS Security Group"
}
]'
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 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
{
"links": [],
"results": [
{
"cidrBlock": "192.0.2.0/24",
"comment": "IP address for Application Server A",
"groupId": "{PROJECT-ID}",
"ipAddress": "192.0.2.15",
"links": []
},
{
"cidrBlock": "203.0.113.0/24",
"comment": "CIDR block for Application Server B - D",
"groupId": "{PROJECT-ID}",
"links": []
},
{
"awsSecurityGroup": "sg-0026348ec11780bd1",
"comment": "Access Listed AWS Security Group",
"groupId": "{PROJECT-ID}",
"links": []
],
"totalCount": 3
}
Give Feedback