Navigation
You were redirected from a different version of the documentation. Click here to go back.
  • API >
  • Configure API Access

Configure API Access

On this page

To access the Cloud Manager API using applications, generate an API key for your organization.

API Keys can’t use the Cloud Manager Console

Organization-based API Keys aren’t associated with user credentials. You can’t use these API Keys to log in to the Cloud Manager console.

Prerequisite

Require an API Access List for Your Organization

For Cloud Manager users with a non-empty API access list all API access must originate from an IPv4 address in the access list. Ensure your configured access list entries provide appropriate coverage for all clients that require API access. An empty API access list grants access to all API endpoints except those that explicitly require an access list.

Cloud Manager supports requiring an API access list at the organization level, such that any API activity for all projects within that organization must originate from an entry on each respective Cloud Manager user’s API access list. For organizations that require an API access list, Cloud Manager users cannot access any API operations until they define at least one API access list entry.

To require an API access list for an Organization:

  1. Log into Cloud Manager.
  2. Access the Organization using the Context picker in the top-left hand corner of the Cloud Manager UI.
  3. Click Settings from the left hand navigation.
  4. Toggle the Require IP Access List for Cloud Manager Administration API setting to On.

Manage Access to the API

You can set API Keys for an entire organization or project.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.