Personal API Key Whitelist (Deprecated)¶
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.
- You can't create new Personal API Keys.
- You can't access the API using your existing Personal API Keys starting March 1, 2021.
- You must update any existing scripts or tools to use Programmatic API Keys instead.
Don't confuse this resource with the Project IP Access List resource. That resource controls client access to the project's MongoDB clusters.
Use the following resource to retrieve and update your API whitelist.
Users with the Project Owner role in the project perform
whitelisted API operations from the IP addresses you have added to
this list.
Atlas whitelists this resource's POST and DELETE
operations. These endpoints must originate from an address already on
your API whitelist.
You can access the API whitelist only for the current user. The username and API key you use to authenticate must be those of the user identified in the endpoint. The endpoint identifies the user by user ID. To retrieve user IDs, see Get All Users in One Project.
Endpoints¶
| Method | Endpoint | Description |
|---|---|---|
GET | /users/{USER-ID}/whitelist | Get the API Whitelist for the Current User |
GET | /users/{USER-ID}/whitelist/({IP-ADDRESS} | {CIDR-BLOCK}) | Get the API Whitelist Entry for a Specified Address or CIDR Block |
POST | /users/{USER-ID}/whitelist | Add Entries to the User's API Whitelist |
DELETE | /users/{USER-ID}/whitelist/({IP-ADDRESS} | {CIDR-BLOCK}) | Delete an Entry from the User's API Whitelist |