Configure API Access
On this page
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
To access the Cloud Manager API using applications, generate an API key or service account for your organization. To learn more, see Authentication.
Note
You can't use API keys or service accounts to log into the Cloud Manager Console.
Prerequisite
(Optional) Require an API Access List for Your Organization
Cloud Manager allows your Cloud Manager Administration API keys or service accounts to make requests from any address on the internet unless you require an IP access list for the Cloud Manager Administration API. If you require an IP access list, your API keys or service accounts can make API requests only from the location-based IP or CIDR addresses that you specify in the IP access list.
Each API key or service account has its own IP access list. If you require an IP access list for all Cloud Manager Administration API requests, you must define at least one IP access list entry for the API key or service account before you can use it.
When you create a new organization using the Cloud Manager UI, Cloud Manager enables the API access list requirement by default. To disable the IP access list requirement when you create an organization, toggle Require IP Access List for Cloud Manager Administration API to OFF when you create an organization.
To set your organization to require IP access lists for every Cloud Manager Administration API key after organization creation, follow these steps:
In MongoDB Cloud Manager, go to the Organization Settings page.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
Click the Organization Settings icon next to the Organizations menu.
The Organization Settings page displays.
Manage Access to the API
You can set API Keys or service accounts for an entire organization or project. To learn more, see Programmatic Access to Cloud Manager.