Docs Menu

Programmatic Access to Atlas

On this page

  • Manage Programmatic Access to an Organization
  • Manage Programmatic Access to a Project

To grant programmatic access to an organization or project using only the API, you can create an API key. API keys:

  • Have two parts: a Public Key and a Private Key. These serve the same function as a username and Personal API Key when making API requests to Atlas.
  • Cannot be used to log into Atlas through the user interface.
  • Must be granted roles as you would Users to make sure the API Keys can call API endpoints without errors.
  • Can belong to one organization, but may be granted access to any number of projects in that organization.
Note
1
  1. If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
  2. Click Access Manager in the sidebar, or click Access Manager in the navigation bar, then click your organization.
2
3
  1. Enter a Description.
  2. In the Organization Permissions menu, select the new role or roles for the API key.
4
5

The public key acts as the username when making API requests.

6

The private key acts as the password when making API requests.

Warning
Copy and save Public and Private Keys

The Private Key is only shown once: on this page. Click the Copy button to add the Private Key to the clipboard. Save and secure both the Public and Private Keys.

7

Add an API Access List Entry.

  1. Click Add Access list Entry.
  2. Enter an IP address from which you want Atlas to accept API requests for this API Key.

    You can also click Use Current IP Address if the host you are using to access Atlas also will make API requests using this API Key.

  3. Click Save.
8
1
  1. If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
  2. Click Access Manager in the sidebar, or click Access Manager in the navigation bar, then click your organization.
2
3
  1. Click to the right of the API Key.
  2. Click View Details.

The <Public Key> API Key Details modal displays:

  • The obfuscated Private Key
  • The date the Key was last used
  • The date the Key was created
  • The IP addresses from which the Key can access the API
  • The projects to which the Key has been granted access

You can change the roles, description, or access list of an API Key in an Organization.

1
  1. If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
  2. Click Access Manager in the sidebar, or click Access Manager in the navigation bar, then click your organization.
2
3
4

On the Add API Key page:

  1. Modify the Description.
  2. In the Organization Permissions menu, select the new role or roles for the API key.
5
6
  1. To add an IP address or CIDR block from which you want Atlas to accept API requests for this API Key, click Add Access list Entry and type an IP address.

    You can also click Use Current IP Address if the host you are using to access Atlas also will make API requests using this API Key.

  2. To remove an IP address from the access list, click to the right of the IP address.
  3. Click Save.
7
1
  1. If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
  2. Click Access Manager in the sidebar, or click Access Manager in the navigation bar, then click your organization.
2
3
4

Removing an API Key from an Organization also removes that key from any projects to which the key was granted access.

Note
Required Permissions

To perform any of the following actions, you must have the Project Owner role.

1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. Select your desired project from the list of projects in the Projects page.
  3. Click the vertical ellipsis () next to your project name in the upper left corner and select Project Settings.
  4. Click Access Manager in the navigation bar, then click your project.
2
3

On the Create API Key page:

  1. Enter a Description.
  2. In the Project Permissions menu, select the new role or roles for the API key.
4
5

The public key acts as the username when making API requests.

6

The private key acts as the password when making API requests.

Warning
Save Private Key

The Private Key is only shown once: on this page. Click the Copy button to add the Private Key to the clipboard. Save and secure both the Public and Private Keys.

7

Add an API Access List Entry.

  1. Click Add Access List Entry.
  2. Enter an IP address from which you want Atlas to accept API requests for this API Key.

    You can also click Use Current IP Address if the host you are using to access Atlas will also make API requests using this API Key.

  3. Click Save.
8
1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. Select your desired project from the list of projects in the Projects page.
  3. Click the vertical ellipsis () next to your project name in the upper left corner and select Project Settings.
  4. Click Access Manager in the navigation bar, then click your project.
2
3
  1. Click to the right of the API Key.
  2. Click View Details.

The <Public Key> API Key Details modal displays the following information:

  • The obfuscated Private Key
  • The date the key was last used
  • The date the key was created
  • The IP address or addresses from which the API key can access the API
1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. Select your desired project from the list of projects in the Projects page.
  3. Click the vertical ellipsis () next to your project name in the upper left corner and select Project Settings.
  4. Click Access Manager in the navigation bar, then click your project.
2
3
  1. Click to the right of the API Key.
  2. Click Edit Permissions.
4
5
1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. Select your desired project from the list of projects in the Projects page.
  3. Click the vertical ellipsis () next to your project name in the upper left corner and select Project Settings.
  4. Click Access Manager in the navigation bar, then click your project.
2
3
  1. Click to the right of the API Key.
  2. Click Edit Permissions.
Note

Selecting Edit Permissions takes you to the organization level of the Atlas console.

4

You cannot modify an existing API Key access list entry. You must delete and re-create it.

  1. Click to the right of the IP address to remove it.
  2. Add the new IP address from which you want Atlas to accept API requests for this API Key. Use one of the two options:

    • Click Add access list Entry and type an IP address, or
    • Click Use Current IP Address if the host you are using to access Atlas will also make API requests using this API Key.
  3. Click Save.
5
Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.