MongoDB API Roles and Tables

Roles (API key project roles)

Collector / table	Atlas Admin API	Minimum project role
MongoDBAtlasBackupSnapshots	`GET /api/atlas/v2/groups/{projectId}/clusters/{clusterName}/backup/snapshots` (replica set) and GET `.../backup/snapshots/shardedClusters` (sharded)	Project Read Only
MongoDBAtlasBackupRestoreJobs	`GET /api/atlas/v2/groups/{projectId}/clusters/{clusterName}/backup/restoreJobs`	Project Backup Manager
MongoDBAtlasEncryptionAtRests	`GET /api/atlas/v2/groups/{projectId}/encryptionAtRest`	Project Read Only
MongoDBAtlasAlertConfigs	`GET /api/atlas/v2/groups/{projectId}/alertConfigs`	Project Read Only
MongoDBAtlasAuditLogs	`GET /api/atlas/v2/groups/{projectId}/auditLog`	Project Owner

📘
Note
Existing Project Read Only keys get snapshots, encryption-at-rest, and alert configs. They do not get restore jobs (Project Backup Manager) or audit config (Project Owner).

Tables

MongoDBAtlasAlertConfigs

Alert configurations for one Atlas project.

Atlas API key project role - Project Read Only

Composite PK is ID + ConfigID. FK MongoDBAtlasProjectID + ConfigID → MongoDBAtlasProjects (ID, ConfigID), cascade delete. Matcher and notification arrays are stored as serialized JSON; metric/host thresholds are flattened.

Name	Type	Description
ID	string	Unique identifier for the alert configuration from Atlas.
ConfigID	integer	The ID of the configuration within Compyl.
Created	datetime	Date and time the alert configuration was created.
Enabled	boolean	Indicates whether the alert configuration is enabled.
EventTypeName	string	Atlas event type that triggers the alert.
GroupID	string	Atlas project ID (`GroupId`) the alert configuration belongs to.
MatchersSerialized	string	Serialized JSON array of matcher rules that scope the alert.
MetricThresholdMetricName	string	Metric name for metric-threshold alerts.
MetricThresholdMode	string	Metric threshold mode (e.g. `AVERAGE`).
MetricThresholdOperator	string	Comparison operator for the metric threshold.
MetricThresholdThreshold	float	Numeric threshold for the metric.
MetricThresholdUnits	string	Units for the metric threshold.

MongoDBAtlasAuditLogs

Database auditing configuration for one Atlas project.

Composite PK is ID + ConfigID (ID is the Atlas project ID). Unique FK MongoDBAtlasProjectID + ConfigID → MongoDBAtlasProjects (ID, ConfigID), cascade delete. Not available on M0/M2/M5 or serverless.

Atlas API key project role - Project Owner

Name	Type	Description
ID	string	Atlas project ID this auditing configuration belongs to.
ConfigID	integer	The ID of the configuration within Compyl.
AuditAuthorizationSuccess	boolean	Indicates whether successful authentications are audited (`AuthCheck`).
AuditFilter	string	JSON document that specifies which events Atlas records in the audit log.
ConfigurationType	string	"How the audit filter is configured (`NONE`, `FILTER_BUILDER`, or `FILTER_JSON`)."
Enabled	boolean	Indicates whether database auditing is enabled for the project.
MongoDBAtlasProjectID	string	Unique identifier of the Atlas project (`GroupID`).
BatchDate	datetime	The date and time data was synced to our database.

MongoDBAtlasBackupRestoreJobs

Cloud backup restore jobs for one Atlas cluster.

Composite PK is ID + ConfigID. FK MongoDBAtlasClusterID + ConfigID → MongoDBAtlasClusters (ClusterID, ConfigID), cascade delete.

Atlas API key project role - Project Backup Manager

Name	Type	Description
ID	string	Unique identifier for the restore job from Atlas.
ConfigID	integer	The ID of the configuration within Compyl.
Cancelled	boolean	Indicates whether the restore job was cancelled.
DeliveryType	string	"How the restore is delivered (`automated`, `download`, or `pointInTime`)."
Expired	boolean	Indicates whether the restore job expired.
ExpiresAt	datetime	Date and time the restore job expires.
Failed	boolean	Indicates whether the restore job failed.
FinishedAt	datetime	Date and time the restore job completed.
OplogInc	integer	Oplog increment used for a point-in-time restore.
OplogTs	integer	Oplog timestamp (Unix seconds) used for a point-in-time restore.
PointInTimeUTCSeconds	integer	Point-in-time restore timestamp in Unix seconds.
SnapshotID	string	Unique identifier of the snapshot being restored.

MongoDBAtlasBackupSnapshots

Cloud backup snapshots for one Atlas cluster.

Composite PK is ID + ConfigID. FK MongoDBAtlasClusterID + ConfigID → MongoDBAtlasClusters (ClusterID, ConfigID), cascade delete.

Atlas API key project role - Project Read Only

Name	Type	Description
ID	string	Unique identifier for the snapshot from Atlas.
ConfigID	integer	The ID of the configuration within Compyl.
CloudProvider	string	"Cloud provider that stores the snapshot (e.g. `AWS`, `AZURE`, `GCP`)."
CopyRegionsSerialized	string	Serialized JSON list of regions the snapshot is copied to.
CreatedAt	datetime	Date and time Atlas created the snapshot.
Description	string	Optional description of the snapshot.
ExpiresAt	datetime	Date and time the snapshot expires.
FrequencyType	string	"Backup frequency that produced the snapshot (e.g. `hourly`, `daily`, `weekly`)."
MasterKeyUUID	string	"AWS KMS customer master key UUID used to encrypt the snapshot, when encryption is enabled."
MongodVersion	string	MongoDB version of the cluster at snapshot time.
PolicyItemsSerialized	string	Serialized JSON list of backup policy item IDs associated with the snapshot.
ReplicaSetName	string	Name of the replica set the snapshot belongs to.

MongoDBAtlasClusters

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ClusterID	string	Unique identifier for the MongoDB Atlas cluster.
GroupName	string	Name of the Atlas project that contains the cluster.
OrgName	string	Name of the Atlas organization that owns the project.
PlanType	string	"Tier or plan type assigned to the cluster (e.g., `M10`, `M20`)."
TagsSerialized	string	Serialized list of cluster tags for categorization or automation.
AlertCount	integer	Number of open alerts currently associated with the cluster.
AuthEnabled	boolean	Indicates whether authentication is enabled for the cluster.
Availability	string	Current availability or health status of the cluster.
BackupEnabled	boolean	Indicates whether backups are enabled for the cluster.
DataSizeBytes	integer	"Total data size stored within the cluster, in bytes."
Name	string	Human-readable name of the cluster.

MongoDBAtlasCustomDatabaseRoleActions

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
Action	string	Specific database action or privilege assigned to the custom role.
BatchDate	datetime	Date and time when the record was last collected or updated.
MongoDBAtlasCustomDatabaseRoleID	uniqueidentifier	Unique identifier of the associated custom database role.
ID	uniqueidentifier	Unique identifier for this action record within the table.

MongoDBAtlasCustomDatabaseRoleInheritedRoles

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	integer	Unique identifier for this inherited role record within the table.
Db	string	Name of the database where the inherited role is defined.
Role	string	Name of the role that is inherited by the custom database role.
BatchDate	datetime	Date and time when the record was last collected or updated.
MongoDBAtlasCustomDatabaseRoleID	uniqueidentifier	Unique identifier of the associated custom database role.

MongoDBAtlasCustomDatabaseRoleResources

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	integer	Unique identifier for this resource record within the table.
Cluster	boolean	Name of the cluster where the resource resides.
Collection	string	Name of the collection that the role action applies to.
Db	string	Name of the database that the role action applies to.
BatchDate	datetime	Date and time when the record was last collected or updated.
MongoDBAtlasCustomDatabaseRoleActionID	uniqueidentifier	Unique identifier of the associated custom database role action.

MongoDBAtlasCustomDatabaseRoles

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
RoleName	string	Name of the custom database role.
LinksSerialized	string	Serialized JSON of related API or resource links for the role.
MongoDBAtlasProjectID	string	Unique identifier of the Atlas project (groupId) where the role is defined.
BatchDate	datetime	Date and time when the record was last collected or updated.
ID	uniqueidentifier	Unique identifier for this custom database role record within the table.

MongoDBAtlasDatabaseUserRoles

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	uniqueidentifier	Unique identifier for this database user role record within the table.
CollectionName	string	Name of the collection the role applies to (if applicable).
DatabaseName	string	Name of the database the role applies to.
RoleName	string	Name of the role assigned to the database user.
MongoDBAtlasDatabaseUserID	uniqueidentifier	Unique identifier of the associated database user.
BatchDate	datetime	Date and time when the record was last collected or updated.

MongoDBAtlasDatabaseUsers

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	uniqueidentifier	Unique identifier for this database user record within the table.
Username	string	The username of the database user.
AWSIAMType	string	"Specifies if the user authenticates via AWS IAM (e.g., `NONE`, `USER`, `ROLE`)."
DatabaseName	string	Name of the database the user belongs to or authenticates against.
DeleteAfterDate	datetime	"Scheduled deletion date for the user, if applicable."
Description	string	Text description or notes about the database user.
LabelsSerialized	string	"Serialized labels or tags associated with the user (e.g., `JSON`)."
LdapAuthType	string	Indicates LDAP authentication type if used for the user.
OidcAuthType	string	Indicates OIDC authentication type if used for the user.
X509Type	string	Indicates X.509 certificate authentication type if used for the user.
LinksJson	string	JSON object containing related API or resource links for the user.
MongoDBAtlasProjectID	string	Unique identifier of the Atlas project (groupId) where the user is defined.
BatchDate	datetime	Date and time when the record was last collected or updated.

MongoDBAtlasDatabaseUserScopes

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	uniqueidentifier	Unique identifier for this database user scope record within the table.
Name	string	Name of the resource or scope the user has access to.
Type	string	"Type of the scope (e.g., `database`, `collection`, `cluster`)."
MongoDBAtlasDatabaseUserID	uniqueidentifier	Unique identifier of the associated database user.
BatchDate	datetime	Date and time when the record was last collected or updated.

MongoDBAtlasEncryptionAtRests

Encryption-at-rest (customer-managed key) configuration for one Atlas project.
Atlas API key project role - Project Read Only

Name	Type	Description
ID	string	Atlas project ID this encryption configuration belongs to.
ConfigID	integer	The ID of the configuration within Compyl.
EnabledForSearchNodes	boolean	Indicates whether encryption at rest is enabled for dedicated Search nodes.
AwsKmsAccessKeyID	string	AWS IAM access key ID used to access the customer master key.
AwsKmsCustomerMasterKeyID	string	AWS KMS customer master key ID used to encrypt MongoDB master keys.
AwsKmsEnabled	boolean	Indicates whether AWS KMS encryption at rest is enabled for the project.
AwsKmsRegion	string	AWS region of the KMS key (e.g. `US_EAST_1`).
AwsKmsRequirePrivateNetworking	boolean	Indicates whether AWS KMS is accessed over private networking.
AwsKmsRoleID	string	Atlas cloud-provider access role ID used for AWS KMS.
AwsKmsValid	boolean	Indicates whether the AWS KMS key can encrypt and decrypt data.
AzureKeyVaultAzureEnvironment	string	"Azure environment for the credentials (`AZURE`, `AZURE_CHINA`, `AZURE_US_GOVERNMENT`)."
AzureKeyVaultClientID	string	Azure application (client) ID used to access Key Vault.

MongoDBAtlasIntegrations

Name	Type	Description
ID	integer	Unique identifier for the integration record within the table.
Name	string	Name of the integration.
CreatedDate	datetime	Date and time when the integration was created.
ModifiedDate	datetime	Date and time when the integration was last modified.
CreatedBy	string	Identifier or name of the user who created the integration.
ModifiedBy	string	Identifier or name of the user who last modified the integration.
IsEnabled	boolean	Indicates whether the integration is currently enabled.
OrganizationID	string	Unique identifier of the Atlas organization that owns the integration.
ProjectID	string	Unique identifier of the Atlas project associated with the integration.
PublicAPIKey	string	Public API key used by the integration for authentication.
ServiceAccountClientID	string	Client ID of the service account associated with the integration.

MongoDBAtlasOrganizationEvents

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	string	Unique identifier for this organization event record within the table.
ApiKeyID	string	"Identifier of the API key used for the event, if applicable."
Created	datetime	Timestamp when the event was created.
EventTypeName	string	Name of the event type.
GroupID	string	Identifier of the project (group) associated with the event.
IsGlobalAdmin	boolean	Indicates whether the user performing the action is a global admin.
PublicKey	string	Public key associated with the event or user.
RawT	string	Raw timestamp or technical field from Atlas event data.
RawAlertConfigID	string	Raw alert configuration ID from the event payload.
RawCID	string	Raw cluster ID from the event payload.
RawCre	datetime	Raw creation metadata from the event payload.

MongoDBAtlasOrganizations

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	string	Unique identifier for the organization record within the table.
IsDeleted	boolean	Indicates whether the organization has been deleted.
Name	string	Name of the organization.
SkipDefaultAlertsSettings	boolean	Indicates whether default alert settings are skipped for this organization.
LinksJson	string	JSON object containing related API or resource links for the organization.
BatchDate	datetime	Date and time when the record was last collected or updated.

MongoDBAtlasPrivateEndpoints

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	integer	Unique identifier for the private endpoint record within the table.
SrvConnectionString	string	The SRV connection string used to connect to the private endpoint.
Type	string	"Type of the private endpoint (e.g., `AWS`, `Azure`, `GCP`)."
EndpointsSerialized	string	"Serialized list of endpoint details (e.g., `JSON array`)."
MongoDBAtlasServerlessInstanceID	string	Unique identifier of the associated serverless instance.
BatchDate	datetime	Date and time when the record was last collected or updated.

MongoDBAtlasProjectEvents

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	string	Unique identifier for this project event record within the table.
ApiKeyID	string	"Identifier of the API key used for the event, if applicable."
Created	datetime	Timestamp when the event was created.
EventTypeName	string	Name of the event type.
GroupID	string	Identifier of the project (group) associated with the event.
IsGlobalAdmin	boolean	Indicates whether the user performing the action is a global admin.
PublicKey	string	Public key associated with the event or user.
RawT	string	Raw timestamp or technical field from Atlas event data.
RawAlertConfigID	string	Raw alert configuration ID from the event payload.
RawCID	string	Raw cluster ID from the event payload.
RawCre	datetime	Raw creation metadata from the event payload.

MongoDBAtlasProjectIPAccessLists

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	uniqueidentifier	Unique identifier for this IP access list record within the table.
AwsSecurityGroup	string	"AWS security group associated with the IP access entry, if applicable."
CidrBlock	string	CIDR block representing the allowed IP range.
Comment	string	Optional comment or note about the IP access entry.
DeleteAfterDate	datetime	"Scheduled deletion date for this IP access entry, if applicable."
IpAddress	string	Specific IP address allowed by this access entry.
LinksJson	string	JSON object containing related API or resource links.
MongoDBAtlasProjectID	string	Unique identifier of the Atlas project associated with this IP access list entry.
BatchDate	datetime	Date and time when the record was last collected or updated.

MongoDBAtlasProjects

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	string	Unique identifier for the project record within the table.
ClusterCount	integer	Number of clusters within the project.
Created	datetime	Timestamp when the project was created.
Name	string	Name of the project.
RegionUsageRestrictions	string	Specifies any geographic region restrictions for the project.
TagsSerialized	string	"Serialized list of tags associated with the project (e.g., `JSON`)."
WithDefaultAlertsSettings	boolean	Indicates whether default alert settings are enabled for the project.
MongoDBAtlasOrganizationID	string	Unique identifier of the organization that owns the project.
LinksJson	string	JSON object containing related API or resource links.
BatchDate	datetime	Date and time when the record was last collected or updated.
MongoDBAtlasOrganizationConfigID	integer	Internal config ID for the organization associated with the project.

MongoDBAtlasServerlessInstances

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	string	Unique identifier for the serverless instance record within the table.
ConnectionStringsStandardSrv	string	Standard SRV connection string for the serverless instance.
CreateDate	datetime	Timestamp when the serverless instance was created.
MongoDBVersion	string	MongoDB version running on the serverless instance.
Name	string	Name of the serverless instance.
ProviderSettingsBackingProviderName	string	Cloud provider backing the serverless instance.
ProviderSettingsEffectiveDiskSizeGBLimit	integer	Effective disk size limit in GB for the serverless instance.
ProviderSettingsEffectiveProviderName	string	Effective cloud provider being used.
ProviderSettingsProviderName	string	Configured cloud provider for the instance.
ProviderSettingsRegionName	string	Cloud region where the serverless instance is deployed.
ServerlessBackupOptionsServerlessContinuousBackupEnabled	boolean	Indicates if continuous backup is enabled for the serverless instance.

MongoDBAtlasTeams

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
TeamID	string	Unique identifier for the team within the organization.
RoleNamesSerialized	string	"Serialized list of role names assigned to the team (e.g., `JSON`)."
LinksJson	string	JSON object containing related API or resource links for the team.
BatchDate	datetime	Date and time when the record was last collected or updated.

MongoDBAtlasX509Certificates

Name	Type	Description
ConfigID	integer	Internal identifier for this configuration or ingestion record.
ID	integer	Unique identifier for the X.509 certificate record within the table.
CreatedAt	datetime	Timestamp when the certificate was created.
NotAfter	datetime	Expiration date of the certificate.
Subject	string	Subject distinguished name (DN) of the certificate.
LinksJson	string	JSON object containing related API or resource links.
MongoDBAtlasProjectID	string	Unique identifier of the Atlas project associated with the certificate.
BatchDate	datetime	Date and time when the record was last collected or updated.

Bridge Tables

MongoDBAtlasOrganizations_MongoDBAtlasTeams

Name	Type	Description
ID	string	Unique identifier for this record within the table.
ConfigID	integer	Internal identifier for this configuration or ingestion record.
TeamID	string	Unique identifier of the associated team in the organization.

MongoDBAtlasProjects_MongoDBAtlasTeams

Name	Type	Description
ID	string	Unique identifier for this record within the table.
ConfigID	integer	Internal identifier for this configuration or ingestion record.
TeamID	string	Unique identifier of the associated team in the organization.

Roles (API key project roles)

Note

Tables

MongoDBAtlasAlertConfigs

MongoDBAtlasAuditLogs

MongoDBAtlasBackupRestoreJobs

MongoDBAtlasBackupSnapshots

MongoDBAtlasClusters

MongoDBAtlasCustomDatabaseRoleActions

MongoDBAtlasCustomDatabaseRoleInheritedRoles

MongoDBAtlasCustomDatabaseRoleResources

MongoDBAtlasCustomDatabaseRoles

MongoDBAtlasDatabaseUserRoles

MongoDBAtlasDatabaseUsers

MongoDBAtlasDatabaseUserScopes

MongoDBAtlasEncryptionAtRests

MongoDBAtlasIntegrations

MongoDBAtlasOrganizationEvents

MongoDBAtlasOrganizations

MongoDBAtlasPrivateEndpoints

MongoDBAtlasProjectEvents

MongoDBAtlasProjectIPAccessLists

MongoDBAtlasProjects

MongoDBAtlasServerlessInstances

MongoDBAtlasTeams

MongoDBAtlasX509Certificates

Bridge Tables

MongoDBAtlasOrganizations_MongoDBAtlasTeams

MongoDBAtlasProjects_MongoDBAtlasTeams

Learn more...