Navigation

Configure Atlas API Access

To access the Atlas API, generate an API key for your organization.

Important
Personal API Key Deprecation
  • You cannot create new Personal API Keys.
  • You cannot use your existing Personal API Keys to access the API from March 1, 2021.
  • You must update any existing scripts or tools to use Programmatic API Keys instead.
Note
Programmatic API Keys can't use the Cloud Manager Console

Organization API keys aren't associated with user credentials and can't log in to the Atlas console.

For Atlas users with a non-empty API access list, all API access must originate from an IP address on an API access list. Configure your access list entries to include all clients which require API access. An empty API access list grants access to all API endpoints except those that explicitly require an API access list.

You can configure Atlas to require API access listing at the organization level. When this setting is enabled, all API calls within that organization must originate from an entry on each respective Atlas user’s API access list. For organizations that require API access listing, Atlas 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
2
  1. If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
  2. Click the Organization Settings icon next to the Organizations menu.
3

For a description of the Atlas API's principles and conventions, see the API.

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

API keys have two parts: a Public Key and a Private Key. You can't use an API key to log into Atlas through the user interface.

All API keys belong to the organization, but can be given access to a project.

To create and manage API keys, use the Access Manager.

When you create a new API key, Atlas grants key the following permissions:

Organization
Project

You can add more permissions to the new API key when you create it.

To add the new API key created in an organization, invite the API key to the project.

Note
Required Permissions

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

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 Manage.
  2. Select Create API Key.
4
  1. Navigate to the Add API Key page.
  2. Enter a Description.
  3. In the Organization Permissions menu, select the new role or roles for the API key.
5

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

6
7

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.

8
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.
9
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
  1. Click Manage.
  2. Select Create API Key.
4

On the Add API Key page:

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

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

6
7

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.

8
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.
9
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 Invite to Project.
  2. Type the public key into the field.
  3. In the Project Permissions menu, select the new role or roles for the API key.
4
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
Note
Required Permissions

To edit a project API key's access list, you must have the Organization Owner permission. Changing an API key's access list might impact multiple projects.

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
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
4
Important
Personal API keys are deprecated.
  • You cannot create new Personal API Keys.
  • You cannot use your existing Personal API Keys for accessing the API from March 1, 2021.
  • You must update any existing scripts or tools to use Programmatic API Keys instead.

You can no longer create Personal API Keys. You can manage any Personal API Keys that you have currently.

To manage any existing personal API keys:

1
  1. In the upper right corner of the Atlas UI, click your username to access the Account menu.
  2. Under Atlas, click User Preferences.
2

When accessing Atlas through the API, you have the same level of access as you do through the Atlas interface. Your Atlas permissions apply to both the interface and the API.

To access API operations limited to an API access list:

  • Configure your API access list with the IP addresses from which you will issue the whitelisted commands.
  • Grant your API key the Organization Owner permission to issue whitelisted commands.

Address-based access lists protect API operations. Only client requests that originate from a whitelisted IP address are permitted to perform the operations.

Users have their own access lists and own API keys. When you issue an API call, you must use an API key from your user account and must issue the command from an address on your user account's access list. You cannot use your key to issue a whitelisted API request from an address on another user's access list, unless, of course, you've added that address to your own access list.

On the resources pages in this guide, whitelisted operations are marked as such.

1
  1. In the upper right corner of the Atlas UI, click your username to access the Account menu.
  2. Under Atlas, click User Preferences.
2
3
  1. In the Personal API Key Access List section, click Add.
  2. Enter an IP address or CIDR range. To add multiple entries to your access list, repeat this step. If you leave your access list empty, you have no access to protected operations.

    You can enter any of the following:

    Entry
    Grants
    An IP address
    Access to protected operations from that address.
    A CIDR-notated range of IPv4 addresses
    Access to protected operations from those addresses.
1
  1. In the upper right corner of the Atlas UI, click your username to access the Account menu.
  2. Under Atlas, click User Preferences.
2
3
Delete an entry from the API access list.
  1. In the Personal API Key Access List section, click the ellipsis menu to the right of the access list entry you want to delete.
  2. Click Delete."
  3. Click Confirm to confirm that you want to delete this access list entry or Cancel to leave the entry in the access list.
Give Feedback
←  APIAPI Resources →