- 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
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}. |