Skip to main content

MongoDB Atlas

Integrate MongoDB Atlas with Cloudaware to inventory orgs, projects, clusters, and related resources for unified reporting.

info
  • Audience: Cloudaware administrators
  • Outcome: The MongoDB Atlas organization is connected to Cloudaware, and MongoDB Atlas objects are available in CMDB for reporting, ownership review, and operational analysis.

Capabilities​

The integration supports:

  • A centralized CMDB inventory of Atlas organizations, projects, clusters, users, access lists, network links, backups, and related resources.
  • Relationship mappings between MongoDB Atlas objects in the CMDB
  • Search and reporting for MongoDB Atlas objects using CMDB Navigator, CMDB list views, and reports

Prerequisites​

Before you begin, make sure you have:

  • Access to a Cloudaware account.
  • A user with access to the Admin Console and permissions to manage cloud accounts, organizations, and integrations (Cloudaware Administrator).
  • Atlas Public Key and Private Key with read access (from MongoDB Atlas organization Access Manager)

Add a MongoDB Atlas Organization to Cloudaware​

  1. In Cloudaware, go to Admin.
  2. Find MongoDB Atlas, then click + ADD.
  3. Provide the Public Key and Private Key.
  4. Click SAVE.
  5. Confirm that the integration status indicator is green.

View MongoDB Atlas Data in CMDB​

  1. In Cloudaware, open CMDB Navigator.
  2. In the left pane, select ATLAS.
  3. Open an object list, e.g., Atlas Projects, to view records.

Supported Objects​

Cloudaware ingests the following Mongo Atlas objects:

Atlas ObjectCMDB Object API Name
Atlas Access List EntryCA10AT__CaAtlasAccessListEntry__c
Atlas Alert ConfigurationCA10AT__CaAtlasAlertConfiguration__c
Atlas API KeyCA10AT__CaAtlasApiKey__c
Atlas API Key Project LinkCA10AT__CaAtlasApiKeyProjectLink__c
Atlas AWS VPC Endpoint LinkCA10AT__CaAtlasAwsVpcEndpointLink__c
Atlas Cloud Backup SnapshotCA10AT__CaAtlasCloudBackupSnapshot__c
Atlas Cloud Provider Access RoleCA10AT__CaAtlasCloudProviderAccessRole__c
Atlas Data LakeCA10AT__CaAtlasDataLake__c
Atlas Data Lake Private EndpointCA10AT__CaAtlasDataLakePrivateEndpoint__c
Atlas Database Custom RoleCA10AT__CaAtlasDatabaseCustomRole__c
Atlas Database UserCA10AT__CaAtlasDatabaseUser__c
Atlas Database User Role AssociationCA10AT__CaAtlasDatabaseUserRoleAssociation__c
Atlas Database User Scope LinkCA10AT__CaAtlasDatabaseUserScopeLink__c
Atlas MongoDB ClusterCA10AT__CaAtlasMongoDbCluster__c
Atlas Network Peering ConnectionCA10AT__CaAtlasNetworkPeeringConnection__c
Atlas Network Peering ContainerCA10AT__CaAtlasNetworkPeeringContainer__c
Atlas OrganizationCA10AT__CaAtlasOrganization__c
Atlas Private Endpoint ServiceCA10AT__CaAtlasPrivateEndpointService__c
Atlas ProjectCA10AT__CaAtlasProject__c
Atlas Serverless InstanceCA10AT__CaAtlasServerlessInstance__c
Atlas Shared-Tier SnapshotCA10AT__CaAtlasSharedTierSnapshot__c
Atlas Snapshot Export BucketCA10AT__CaAtlasSnapshotExportBucket__c

Troubleshooting​

note

Initial data collection may take time to complete.

Authentication Fails or Integration Shows Red Status​

  • Verify that the Public Key and Private Key are valid and active.
  • Confirm that the API key has read access to the MongoDB Atlas organization.
  • Check that the Atlas API access list allows Cloudaware to connect to the Atlas API.
  • Re-enter the credentials by editing the integration in Cloudaware.

Atlas Objects Are Missing​

  • Wait for the next collection cycle to complete.
  • Confirm that the Atlas organization contains projects and clusters available to the API key.
  • Review the integration status and error messages in Cloudaware Admin.
  • In CMDB Navigator, verify that you are viewing the ATLAS section and related resources.

Still stuck? Contact Cloudaware Support at support@cloudaware.com with the integration name and a brief description of the issue.

Reconfigure or Remove the Integration​

Update the Integration Details​

warning

To rotate credentials, edit the existing integration instead of deleting and re-creating it.

  1. Go to Admin.
  2. Select MongoDB Atlas.
  3. Select the specific integration.
  4. Open the three-dot menu (⋮), then click Edit.
  5. Update the Public Key and Private Key. Click Save.
  6. Save the integration and confirm that the status turns green.

Remove the Integration from Cloudaware​

  1. Go to Admin.
  2. Select MongoDB Atlas.
  3. Select the specific integration.
  4. Open the three-dot menu (⋮), then click Delete.
  5. Confirm the deletion if prompted.

Security Notes​

  • Use Atlas API keys with the minimum permissions required for discovery. Read-only access is recommended for inventory collection.
  • Store the Public Key and Private Key only in approved credential stores and avoid sharing them through tickets, chat, or documentation.
  • Rotate Atlas API keys periodically and immediately after suspected exposure or personnel changes.
  • Review integration activity and collection errors regularly to detect expired credentials, permission changes, or unexpected access issues.