> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MongoDB Atlas

> How to set up the MongoDB Atlas connector, plus the actions and events that are available.

![MongoDB Atlas](https://stackone-logos.com/api/mongodb/filled/svg)

v1.3.2[See changelog](https://docs.stackone.com/connectors/mongodb/changelog.md)

[71 actions](#actions) · [2 events](#events) · 1 auth method

Databases
Observability
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/mongodb/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Connect using a MongoDB Atlas Service Account (OAuth 2.0 client credentials). Create a Service Account under Organizatio...

Optionally, configure receiving Events for MongoDB Atlas into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/mongodb/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/mongodb/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

71 actions

ActionDescription

List Alert Configurations`mongodb_list_alert_configs`

Lists all alert configurations (the rules defining alert triggers and notification targets) for the given Atlas project.

Get Alert Configuration`mongodb_get_alert_config`

Retrieves a single alert configuration (rule) from an Atlas project by its alert configuration ID.

Create Alert Configuration`mongodb_create_alert_config`

Creates a new alert configuration (rule) in an Atlas project, defining the event that triggers an alert and where notifi...

Update Alert Configuration`mongodb_update_alert_config`

Replaces an existing alert configuration (rule) in an Atlas project by its ID, overwriting the trigger event, thresholds...

Delete Alert Configuration`mongodb_delete_alert_config`

Permanently deletes an alert configuration (rule) from an Atlas project by its alert configuration ID.

List Alerts`mongodb_list_alerts`

Lists all fired alerts in one Atlas project (GET /groups/\{groupId}/alerts). An alert fires when a monitored component cr...

Get Alert`mongodb_get_alert`

Retrieves one fired alert by its ID within an Atlas project (GET /groups/\{groupId}/alerts/\{alertId}), including its stat...

Acknowledge Alert`mongodb_acknowledge_alert`

Acknowledges (silences) one open alert in an Atlas project (PATCH /groups/\{groupId}/alerts/\{alertId}), suppressing furth...

List API Keys`mongodb_list_api_keys`

Lists all programmatic organization API keys in a MongoDB Atlas organization (orgId), returning each key's ID, descripti...

Get API Key`mongodb_get_api_key`

Retrieves a single organization API key by its apiUserId within a MongoDB Atlas organization (orgId), returning its desc...

Create API Key`mongodb_create_api_key`

Creates a new programmatic organization API key in a MongoDB Atlas organization (orgId), requiring a description and at...

Delete API Key`mongodb_delete_api_key`

Permanently deletes an organization API key (apiUserId) from a MongoDB Atlas organization (orgId), immediately revoking...

List Backup Snapshots`mongodb_list_backup_snapshots`

Lists all cloud backup SNAPSHOTS (point-in-time copies of stored data) for one cluster in a project, returning each snap...

List Backup Restore Jobs`mongodb_list_backup_restore_jobs`

Lists all cloud backup RESTORE JOBS for one cluster in a project, showing each recovery operation's status, delivery typ...

Get Backup Snapshot`mongodb_get_backup_snapshot`

Retrieves one cloud backup SNAPSHOT by its snapshotId, returning its full metadata (creation time, status, size, retenti...

Create Backup Snapshot`mongodb_create_backup_snapshot`

Takes one on-demand cloud backup SNAPSHOT of a cluster immediately (outside the scheduled backup policy), returning the...

Create Backup Restore Job`mongodb_create_backup_restore_job`

Creates a backup RESTORE JOB that recovers a cluster's data from a snapshot, either restoring into a target cluster (aut...

List Organization Users`mongodb_list_organization_users`

Lists the human MongoDB Cloud USERS (both active and pending-invitation) that belong to an organization, returning each...

Get Organization User`mongodb_get_organization_user`

Retrieves one human MongoDB Cloud USER by userId within an organization, returning their username/email, org roles, team...

Create Organization User`mongodb_create_organization_user`

Invites a human user (new or existing MongoDB Cloud account) to join an organization with the given roles, creating a PE...

Update Organization User`mongodb_update_organization_user`

Updates one human MongoDB Cloud USER in an organization (active or still pending), changing their org roles and/or team...

List Clusters`mongodb_list_clusters`

Lists all dedicated and Flex database clusters within a single project (groupId), returning each cluster's name, instanc...

Get Cluster`mongodb_get_cluster`

Retrieves the full details of a single cluster by project (groupId) and clusterName, including its current state, instan...

Create Cluster`mongodb_create_cluster`

Provisions a new database cluster in a project (groupId), with its topology, region, instance size, MongoDB version, and...

Update Cluster`mongodb_update_cluster`

Modifies an existing cluster identified by groupId and clusterName — for example to scale the instance size, change the...

Delete Cluster`mongodb_delete_cluster`

Permanently deletes a single cluster (by groupId and clusterName) and its data, leaving the parent project intact. Runs...

List Custom Database Roles`mongodb_list_custom_db_roles`

Lists all custom database roles defined in the given Atlas project (groupId), including their granted privilege actions...

Get Custom Database Role`mongodb_get_custom_db_role`

Retrieves a single custom database role from an Atlas project by its role name, including its privilege actions and inhe...

Create Custom Database Role`mongodb_create_custom_db_role`

Creates a new custom database role in an Atlas project, defining its privilege actions and/or the built-in roles it inhe...

Update Custom Database Role`mongodb_update_custom_db_role`

Updates an existing custom database role in an Atlas project (by role name), replacing its privilege actions and inherit...

Delete Custom Database Role`mongodb_delete_custom_db_role`

Permanently deletes a custom database role from an Atlas project by its role name.

List Database Users`mongodb_list_database_users`

Lists every database user in the given Atlas project (groupId), returning their username, authentication database, roles...

Get Database User`mongodb_get_database_user`

Retrieves a single database user from an Atlas project, identified by its authentication database and username.

Create Database User`mongodb_create_database_user`

Creates a new database user (a data-plane credential) in an Atlas project with the given username, authentication databa...

Update Database User`mongodb_update_database_user`

Updates an existing database user in an Atlas project (identified by authentication database + username), fully replacin...

Delete Database User`mongodb_delete_database_user`

Permanently deletes a database user from an Atlas project, identified by its authentication database and username.

List Project Events`mongodb_list_project_events`

Lists audit-log events scoped to one Atlas project (GET /groups/\{groupId}/events) — database, billing, and security acti...

List Organization Events`mongodb_list_organization_events`

Lists audit-log events scoped to one Atlas organization (GET /orgs/\{orgId}/events) — org-wide database, billing, and sec...

List Flex Clusters`mongodb_list_flex_clusters`

Lists all MongoDB Atlas flex clusters in a project (groupId), returning each cluster's name, state, and connection detai...

Get Flex Cluster`mongodb_get_flex_cluster`

Retrieves a single MongoDB Atlas flex cluster by its name within a project (groupId), returning its state, provider sett...

Create Flex Cluster`mongodb_create_flex_cluster`

Creates a new MongoDB Atlas flex cluster in a project (groupId), requiring a cluster name and providerSettings (cloud pr...

Delete Flex Cluster`mongodb_delete_flex_cluster`

Permanently deletes a MongoDB Atlas flex cluster by name from a project (groupId), destroying the instance and its data;...

Get Unified Credentials`mongodb_unified_get_me`

Get the current MongoDB Atlas connection's unified credentials and identity.

List Unified Groups`mongodb_unified_list_groups`

List unified groups in MongoDB Atlas.

Get Unified Group`mongodb_unified_get_group`

Get a unified MongoDB Atlas team by ID.

List Unified Organizations`mongodb_unified_list_organizations`

List unified organizations in MongoDB Atlas.

Get Unified Organization`mongodb_unified_get_organization`

Get a unified MongoDB Atlas organization by ID.

List Unified Resource Types`mongodb_unified_list_resource_types`

List unified resource types in MongoDB Atlas.

List Unified Resource Users`mongodb_unified_list_resource_users`

List unified users with access to a specific MongoDB Atlas project.

List Unified Roles`mongodb_unified_list_roles`

List unified roles in MongoDB Atlas.

Get Unified Role`mongodb_unified_get_role`

Get a unified MongoDB Atlas organization role by ID.

List Unified Users`mongodb_unified_list_users`

List unified users in MongoDB Atlas.

Get Unified User`mongodb_unified_get_user`

Get a unified MongoDB Atlas user by ID.

List Organizations`mongodb_list_organizations`

Lists every MongoDB Atlas organization the authenticated Service Account or API Key can access, returning each organizat...

Get Organization`mongodb_get_organization`

Retrieves the details of a single MongoDB Atlas organization by its orgId, including name, status, and account-level set...

List Organization Projects`mongodb_list_organization_projects`

Lists all projects (groups) that belong to one specific organization (orgId), returning each project's groupId, name, an...

Create Organization`mongodb_create_organization`

Creates a new MongoDB Atlas organization and links it under the calling credential's existing (paying) organization, ret...

Update Organization`mongodb_update_organization`

Updates a MongoDB Atlas organization identified by orgId — primarily its human-readable name and its default-alert-creat...

List IP Access List Entries`mongodb_list_ip_access_list_entries`

Lists all IP access list entries for a project — the IP addresses, CIDR blocks, and AWS security groups from which Atlas...

Get IP Access List Entry`mongodb_get_ip_access_list_entry`

Retrieves one IP access list entry from a project by its entry value (an IP address, CIDR block, or AWS security group I...

Create IP Access List Entries`mongodb_create_ip_access_list_entries`

Adds one or more IP access list entries to a project so clients from those sources can connect to its clusters, taking a...

Delete IP Access List Entry`mongodb_delete_ip_access_list_entry`

Removes one IP access list entry from a project by its entry value, revoking cluster network access from that IP address...

List Projects`mongodb_list_projects`

Lists every MongoDB Atlas project (called a "group" in the API) that the authenticated Service Account or API Key can ac...

Get Project`mongodb_get_project`

Retrieves the full details of a single MongoDB Atlas project (a.k.a. "group") by its groupId, including name, orgId, clu...

Create Project`mongodb_create_project`

Creates a new MongoDB Atlas project (a.k.a. "group") inside an existing organization and returns it with its newly assig...

Update Project`mongodb_update_project`

Updates a project's mutable settings by groupId — its human-readable name, its tags, and whether default alerts are auto...

Delete Project`mongodb_delete_project`

Permanently deletes an entire MongoDB Atlas project (group) by groupId, along with everything it contains. Succeeds only...

List Teams`mongodb_list_teams`

Lists all teams in a MongoDB Atlas organization (identified by orgId), returning each team's ID, name, and member count.

Get Team`mongodb_get_team`

Retrieves a single MongoDB Atlas team by its teamId within the given organization (orgId), returning the team's name and...

Create Team`mongodb_create_team`

Creates a new team in a MongoDB Atlas organization (orgId), requiring a name and an initial list of member usernames.

Delete Team`mongodb_delete_team`

Permanently deletes a MongoDB Atlas team (teamId) from an organization (orgId), immediately revoking the project access...

## Events

Tags

Select all
|
Clear

Alerts

Webhooks

No tags found

2 events

EventDescriptionTags

Alert`mongodb_webhook_alert`

Emitted when a MongoDB Atlas alert that notifies via webhook opens, updates, or closes. Maps to the Atlas alert payload,...

AlertsWebhooks

Active Check`mongodb_active_check`

Acknowledges any webhook delivery that is not a routable Atlas alert — for example a connectivity or verification POST,...

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.