Skip to main content
MongoDB Atlas
MongoDB Atlas
60 actions · 1 auth method
PreviewObservabilityIAMInfrastructure

​
Authentication

OAuth 2.0 - Service Account

Connect using a MongoDB Atlas Service Account (OAuth 2.0 client credentials). Create a Service Account under Organizatio…Guides: Connector Profile, Link Account
Actions
60 actions
Action
Description
List Alert Configurations
Lists all alert configurations (the rules defining alert triggers and notification targets) for the given Atlas project.
Get Alert Configuration
Retrieves a single alert configuration (rule) from an Atlas project by its alert configuration ID.
Create Alert Configuration
Creates a new alert configuration (rule) in an Atlas project, defining the event that triggers an alert and where notifi…
Update Alert Configuration
Replaces an existing alert configuration (rule) in an Atlas project by its ID, overwriting the trigger event, thresholds…
Delete Alert Configuration
Permanently deletes an alert configuration (rule) from an Atlas project by its alert configuration ID.
List Alerts
Lists all fired alerts in one Atlas project (GET /groups/{groupId}/alerts). An alert fires when a monitored component cr…
Get Alert
Retrieves one fired alert by its ID within an Atlas project (GET /groups/{groupId}/alerts/{alertId}), including its stat…
Acknowledge Alert
Acknowledges (silences) one open alert in an Atlas project (PATCH /groups/{groupId}/alerts/{alertId}), suppressing furth…
List API Keys
Lists all programmatic organization API keys in a MongoDB Atlas organization (orgId), returning each key’s ID, descripti…
Get API Key
Retrieves a single organization API key by its apiUserId within a MongoDB Atlas organization (orgId), returning its desc…
Create API Key
Creates a new programmatic organization API key in a MongoDB Atlas organization (orgId), requiring a description and at…
Delete API Key
Permanently deletes an organization API key (apiUserId) from a MongoDB Atlas organization (orgId), immediately revoking…
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
Lists all cloud backup RESTORE JOBS for one cluster in a project, showing each recovery operation’s status, delivery typ…
Get Backup Snapshot
Retrieves one cloud backup SNAPSHOT by its snapshotId, returning its full metadata (creation time, status, size, retenti…
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
Creates a backup RESTORE JOB that recovers a cluster’s data from a snapshot, either restoring into a target cluster (aut…
List Organization Users
Lists the human MongoDB Cloud USERS (both active and pending-invitation) that belong to an organization, returning each…
Get Organization User
Retrieves one human MongoDB Cloud USER by userId within an organization, returning their username/email, org roles, team…
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
Updates one human MongoDB Cloud USER in an organization (active or still pending), changing their org roles and/or team…
List Clusters
Lists all dedicated and Flex database clusters within a single project (groupId), returning each cluster’s name, instanc…
Get Cluster
Retrieves the full details of a single cluster by project (groupId) and clusterName, including its current state, instan…
Create Cluster
Provisions a new database cluster in a project (groupId), with its topology, region, instance size, MongoDB version, and…
Update Cluster
Modifies an existing cluster identified by groupId and clusterName — for example to scale the instance size, change the…
Delete Cluster
Permanently deletes a single cluster (by groupId and clusterName) and its data, leaving the parent project intact. Runs…
List Custom Database Roles
Lists all custom database roles defined in the given Atlas project (groupId), including their granted privilege actions…
Get Custom Database 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
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
Updates an existing custom database role in an Atlas project (by role name), replacing its privilege actions and inherit…
Delete Custom Database Role
Permanently deletes a custom database role from an Atlas project by its role name.
List Database Users
Lists every database user in the given Atlas project (groupId), returning their username, authentication database, roles…
Get Database User
Retrieves a single database user from an Atlas project, identified by its authentication database and username.
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
Updates an existing database user in an Atlas project (identified by authentication database + username), fully replacin…
Delete Database User
Permanently deletes a database user from an Atlas project, identified by its authentication database and username.
List Project Events
Lists audit-log events scoped to one Atlas project (GET /groups/{groupId}/events) — database, billing, and security acti…
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
Lists all MongoDB Atlas flex clusters in a project (groupId), returning each cluster’s name, state, and connection detai…
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
Creates a new MongoDB Atlas flex cluster in a project (groupId), requiring a cluster name and providerSettings (cloud pr…
Delete Flex Cluster
Permanently deletes a MongoDB Atlas flex cluster by name from a project (groupId), destroying the instance and its data;…
List Organizations
Lists every MongoDB Atlas organization the authenticated Service Account or API Key can access, returning each organizat…
Get Organization
Retrieves the details of a single MongoDB Atlas organization by its orgId, including name, status, and account-level set…
List Organization Projects
Lists all projects (groups) that belong to one specific organization (orgId), returning each project’s groupId, name, an…
Create Organization
Creates a new MongoDB Atlas organization and links it under the calling credential’s existing (paying) organization, ret…
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
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
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
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
Removes one IP access list entry from a project by its entry value, revoking cluster network access from that IP address…
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
Retrieves the full details of a single MongoDB Atlas project (a.k.a. “group”) by its groupId, including name, orgId, clu…
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
Updates a project’s mutable settings by groupId — its human-readable name, its tags, and whether default alerts are auto…
Delete Project
Permanently deletes an entire MongoDB Atlas project (group) by groupId, along with everything it contains. Succeeds only…
List Teams
Lists all teams in a MongoDB Atlas organization (identified by orgId), returning each team’s ID, name, and member count.
Get Team
Retrieves a single MongoDB Atlas team by its teamId within the given organization (orgId), returning the team’s name and…
Create Team
Creates a new team in a MongoDB Atlas organization (orgId), requiring a name and an initial list of member usernames.
Delete Team
Permanently deletes a MongoDB Atlas team (teamId) from an organization (orgId), immediately revoking the project access…

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.

Connector Profile

MongoDB Atlas - OAuth 2.0 - Service Account
3

Link an Account

Connect an account using StackOne Hub or Auth Link.

Link Account

MongoDB Atlas - OAuth 2.0 - Service Account
4

Use Actions

Invoke actions using one of the methods below: