- API >
- API Resources >
- Project IP Whitelist
Project IP Whitelist¶
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 IP whitelist entries in the project’s Activity Feed. Atlas audits actions pertaining to both temporary and non-temporary entries. To view the project’s Activity Feed, click Alerts in the left navigation pane and select the All Activity tab. For more information on the project Activity Feed, see View All Activity.
Note
Atlas does not report updates to a whitelist entry’s comment in the Activity Feed.
When you modify the address of a whitelist 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/{GROUP-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}. |
POST |
/groups/{GROUP-ID}/whitelist | Update one or more whitelist entries in 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}. |