Skip to main content
Vantage integrates with your MongoDB account using the Invoices API. To see Active Resources for your MongoDB Atlas account, Vantage uses the Clusters API and the Projects API.

​
Connect Your MongoDB Atlas Account

​
Prerequisites

  • To create an API key for Vantage to ingest costs, you must be an Organization Owner inside the MongoDB Atlas console.
  • To add the API key to relevant projects to use Active Resource inventories inside Vantage, you must be a Project Owner in the MongoDB Atlas console.
    For more information on user roles in MongoDB Atlas, see the MongoDB Atlas documentation.
  • You must have a Vantage Organization Owner or Integration Owner role to add or remove this integration. See the Role-Based Access Control documentation for details.
  • Create a free Vantage account, then follow the steps below to integrate MongoDB Atlas costs.

​
Step 1 - Review the Vantage Integration Page

Navigate to the MongoDB Atlas Settings page in the Vantage console. Then, click Add API Key. You will need to add your Organization ID, Public API key, and Private API key. Detailed steps for obtaining each of these items are provided below. Leave this tab open so you can go back and populate these fields as you obtain each value.
Add MongoDB information in the Vantage console

​
Step 2 - Obtain Organization ID

1
In a new browser tab, navigate to the MongoDB Atlas console.
2
At the top of the page, click the Organization dropdown menu, and select your organization.
3
On the left menu, click Organization Settings.
4
Your Organization ID will be displayed at the top. Copy the Organization ID. Then, go back to your Vantage browser tab and paste your ID into the Organization ID field.
Obtain Organization ID in MongoDB Atlas

​
Step 3 - Create an Organization API Key

Next, you’ll create an API key and grant it read-only permissions to your invoices and, optionally, to cluster-level cost data.
1
From the left navigation menu, click Applications.
2
Select the API Keys tab, then click Create API Key (or click Add new > API Key at the top if you already have created one).
View API key creation screen in MongoDB Atlas
3
On the Create API Key screen, configure the following details:
  • For Description, enter a name, like Vantage Integration.
  • For Organization Permissions, select Organization Billing Viewer and Organization Read Only.
Edit API key permissions in MongoDB Atlas
4
Click Next. Your public and private keys are displayed. Copy the keys and paste them into the Public API key and Private API key fields in Vantage.
If your organization requires an IP Access List for access control, you will need to add each of the following IPs to the API Access List section. Add each IP address individually:
Copy API keys in MongoDB Atlas
5
At the bottom, click Done.
If you want to have Vantage ingest per-cluster resource data from MongoDB Atlas, then proceed to the next section. Otherwise, back in the Vantage console, click Add Key.

​
Step 4 - Grant Project Access for Active Resources

1
On the left navigation menu, under Identity & Access, select All Projects to see your list of Atlas projects. Select your project from the list.
Open MongoDB Atlas projects
2
On the left menu, select Project Identity & Access.
3
Click Invite to Project.
Invite to project in MongoDB Atlas
4
Search for and select the Vantage Integration API key to add it to the project.
5
Grant the Vantage Integration API key Project Read Only access. Then, click Invite to Project. Repeat this process for any other projects where you want to see resource-level costs.
Grant API key read-only access to project
6
Back in the Vantage console, click Add Key.
After clicking Add Key, your MongoDB Atlas integration status should automatically update to Importing within the Vantage console. This status indicates that Vantage is actively importing your MongoDB Atlas cost data. If you’ve successfully granted project access for active resources, your Active Resources view will begin populating with cost data. See the Integration Status documentation for details on integration statuses.

​
Next Steps - Manage Workspace Access

Once the import is complete and the integration status changes to Stable, you can select which workspaces this integration is associated with. See the Workspaces documentation for information.

​
Set Custom Rates

If you have negotiated pricing with MongoDB, set a unit price multiplier to adjust the MongoDB Atlas costs shown in Vantage. Vantage multiplies MongoDB Atlas costs by the rate you enter. The default rate is 1.0 (no adjustment). For example, a rate of 0.8 reflects a 20% discount.
1

Open the integration

Navigate to the MongoDB Atlas Settings page and select your integration.
2

Enter a rate

In the Custom rates section, enter a value in the Unit price multiplier field. To apply a rate only to a specific period, select a Date range. Leave the date range blank for a rate that applies to all billing periods.
3

Add rates for other periods (optional)

If your pricing changed over time, click Add rate to add another row with its own rate and date range.
4

Save

Click Save. Cost Reports are updated shortly after saving.
When you configure multiple rates:
  • Each rate must be greater than 0, and each start date must be on or before its end date.
  • Date ranges can’t overlap.
  • A rate without a date range can’t be combined with other rates.
  • Only one rate can have an open start date, and only one rate can have an open end date.

​
Data Refresh

See the provider data refresh documentation for information on when data for each provider refreshes in Vantage.

​
MongoDB Atlas Reporting Dimensions

On MongoDB Atlas Cost Reports, you can filter across several dimensions:
  • Project (project name when available, otherwise project ID)
  • Category (Atlas Cluster - Atlas Instance M2)
  • Tag (includes MongoDB tags and virtual tags created in Vantage for this provider)
  • Provider Tag (mongo:group_name, the Atlas project name from invoice data)
  • Resource (service resource ID)
  • Charge Type (e.g., Usage)
  • Organization (organization name)
  • Service (e.g., REALM)
Credits are not displayed for MongoDB Atlas costs in Vantage. The MongoDB Atlas provider API does not make credit information available for retrieval.

​
Active Resources

MongoDB Atlas clusters are synced as active resources and available in resource reports.