MongoDB® Atlas Integration

For a successful MongoDB Atlas integration, all you need is an API key.

This page covers:

• Generating an API key using the MongoDB Atlas user interface.
• Generating an API key using Attribute's automated CLI tool.
• Handling Atlas's API Access List for API keys.

When creating an API key, keep the following in mind:

1. Use organization-level authentication. Atlas supports both organizational and project-level authentication. To ensure visibility across your entire MongoDB Atlas deployment, the API key must be created at the organization level.
2. Permissions required. The API key must include both Organization Billing Viewer and Organization Read Only.
3. Role required. To generate an API key, you need the Organization Owner role.

Generating an API Key

Using the MongoDB Atlas UI

1. Browse and sign in to MongoDB Cloud.

2. Using the drop-down organization selector at the top-left of your screen, select the Atlas organization you'd like to create the deployment for.

   

3. Select Access Manager on the left sidebar. If you can't find it, click the gear icon to the right of your organization name (next to the organization selector).

4. On the Access Manager page, look for the Add new button in the top-right and select API Key.

   

5. Provide a description such as Attribute, then select both Organization Billing Viewer and Organization Read Only permissions.

   

6. Click Next, then copy both the Public Key and the Private Key.

   

   注意

   The private key is only displayed once. Submit it to Attribute immediately — and also share your Organization ID. If you can't share it right away, store it somewhere safe.

7. If your Atlas organization enforces an IP Access List for the Atlas API, you'll need to add access list entries for the new key. See API Access List below to check whether your organization enforces this, and how to add entries.

Using Attribute's Automated Tool

1. Make sure you have the Atlas CLI installed. See the Atlas CLI documentation if you need to install it.

2. Execute the script and follow the on-screen instructions.

The tool walks you through logging in with the Atlas CLI, prompts you to choose the organization to create the key for, creates the key, and applies Attribute's IP addresses to the new key's IP Access List automatically.

Read the tool's instructions and messages closely.

API Access List

Check API Access List Status

To find out whether your Atlas organization requires an IP access list for the Atlas Administration API, navigate to your organization's Settings using the left menu.

Then check the Require IP Access List for the Atlas Administration API toggle:

• If the toggle is off (as in the example above), no further action is needed — submit your keys to Attribute.
• If the toggle is on, continue to the next section to add IP access entries.

Adding IP Access Entries

1. Go back to the Access Manager page, click the three dots next to the new API key, and choose Edit Permissions.

   

2. Click Next, then Add Access List Entry.

   

3. Add the following IP addresses:

   • 34.41.229.120
   • 35.224.163.103

   

4. Click Done — and that's it. Submit your keys to Attribute.

Contact

If you require any additional assistance, please contact Attribute's support at [email protected].

Alternatively, you can request to join a shared Slack channel for support. To request access, email [email protected] with your details.

---

Trademarks: MongoDB is a registered trademark of MongoDB, Inc. All other trademarks are the property of their respective owners.