Navigation

Programmatic Access to Atlas

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.

Manage Programmatic Access to an Organization

Required Permissions

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

Create an API Key in an Organization

1
2

Click the API Keys tab

3

Create an API Key.

  1. Click Manage.
  2. Select Create API Key.
4

On the Add API Key page, enter the API Key Information.

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

Copy and save the Public Key.

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

6

Click Next.

7

Copy and save the Private Key.

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

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 Whitelist.

  1. Click Add Whitelist Entry.

  2. Enter an IPv4 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

Click Done.

View the Details of an API Key in an Organization

1

Navigate to the Access Manager page for your organization.

  1. If it is not already displayed, select your desired organization from the office icon 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

Click the API Keys tab

3

From the ellipsis menu to the right of the API Key, 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 IPv4 addresses on which the Key is whitelisted
  • The projects to which the Key has been granted access

Change an API Key in an Organization

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

1

Navigate to the Access Manager page for your organization.

  1. If it is not already displayed, select your desired organization from the office icon 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

Click the API Keys tab

3

From the ellipsis menu to the right of the API Key you want to change, click Edit.

4

On the Add API Key page, edit the API Key Information.

  1. Modify the Description.
  2. In the Organization Permissions menu, select the new role or roles for the API key.
5

Click Next.

6

Edit the API Whitelist.

  1. To add an IP address from which you want Atlas to accept API requests for this API Key, click Add Whitelist Entry and type an IPv4 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 a whitelisted IP address, click trash icon to the right of the whitelisted IP address.

  3. Click Save.

7

Click Done.

Delete an API Key from an Organization

1

Navigate to the Access Manager page for your organization.

  1. If it is not already displayed, select your desired organization from the office icon 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

Click the API Keys tab

3

Click trash icon to the right of the API Key that you want to delete.

4

Click Delete to confirm that you want to delete this API Key or Cancel to leave the key in the Organization.

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

Manage Programmatic Access to a Project

Required Permissions

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

Create an API Key for a Project

1
2

Click the API Keys tab

3

Create an API Key.

  1. Click Manage.
  2. Select Create API Key.
4

On the Add API Key page, enter the API Key Information.

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

Copy and save the Public Key.

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

6

Click Next.

7

Copy and save the Private Key.

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

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 Whitelist.

  1. Click Add Whitelist Entry.

  2. Enter an IPv4 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

Click Done.

View the Details of an API Key in a Project

1

Navigate to the Access Manager page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Project menu in the navigation bar.
  3. Click Access Manager in the navigation bar, then click your project.
2

Click the API Keys tab

3

From the ellipsis menu to the right of the API Key, click View Details.

The <Public Key> API Key Details modal displays the obfuscated Private Key, the date the key was last used, the date it was created, and the IPv4 addresses on which the key is whitelisted.

Change an API Key’s Roles in a Project

1

Navigate to the Access Manager page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Project menu in the navigation bar.
  3. Click Access Manager in the navigation bar, then click your project.
2

Click the API Keys tab

3

From the ellipsis menu to the right of the API Key, click Edit Permissions.

4

Select the new role or roles for the API Key from the Project Permissions menu.

5

Click the check icon to save.

Edit an API Key’s Whitelist

1

Navigate to the Access Manager page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Project menu in the navigation bar.
  3. Click Access Manager in the navigation bar, then click your project.
2

Click the API Keys tab

3

From the ellipsis menu to the right of the API Key, click Edit Whitelist.

Note

Selecting Edit Whitelist takes you to the organization level of the Atlas UI.

4

Edit the API Whitelist.

Note

You cannot edit an individual whitelist entry. If you need to modify a whitelist entry, delete and re-create it.

  1. To add an IP address from which you want Atlas to accept API requests for this API Key, click Add Whitelist Entry and type an IPv4 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 a whitelisted IP address, click trash icon to the right of the whitelisted IP address.

  3. Click Save.

5

Click Done.