Navigation

Project IP Whitelist

Access List Replaces 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.

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.

The whitelist endpoint manages a Atlas project’s IP whitelist.

The whitelist endpoint supports creating temporary whitelist entries that automatically expire within a user-configurable 7-day period.

Atlas audits the creation, deletion, and updates of both temporary and non-temporary IP access list entries in the project’s Activity Feed.

To view the project’s Activity Feed, click Activity Feed in the Project section of the left navigation pane.

See also

View All Activity.

Activity Feed Considerations

  • Atlas does not report updates to an IP access list entry’s comment in the Activity Feed.
  • When you modify the address of an IP access list entry, the Activity Feed reports two new activities: one for the deletion of the old entry and one for the creation of the new entry.

Important

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.

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

Method Endpoint Description
GET /groups/{GROUP-ID}/whitelist Get all whitelist entries in the project associated to {GROUP-ID}.
GET /groups/{GROUP-ID}/whitelist/{WHITELIST-ENTRY} Get the whitelist entry specified to {WHITELIST-ENTRY} from the project associated to {GROUP-ID}.
POST /groups/{GROUP-ID}/whitelist Add one or more whitelist entries to the project associated to {GROUP-ID}.
DELETE /groups/{GROUP-ID}/whitelist/{WHITELIST-ENTRY} Delete the whitelist entry specified to {WHITELIST-ENTRY} from the project associated to {GROUP-ID}.