MongoDB Atlas CLI

https://www.mongodb.com/docs/atlas/cli/current/
Admin
MongoDB Atlas CLI is a command-line interface for managing MongoDB Atlas database deployments and...
Tokens:175,504
Snippets:2,141
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start a Cluster Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-start

Example command to start a specific cluster within a designated project.

```text
# Start a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas clusters start myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json
```

--------------------------------

### Clone the example plugin repository

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-extend-plugins

Use the official example repository as a starting point for plugin development.

```bash
git clone https://github.com/mongodb/atlas-cli-plugin-example.git
cd atlas-cli-plugin-example
```

--------------------------------

### Install latest plugin version

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-plugin-install

Examples of installing the latest release of a plugin using repository shorthand or a full URL.

```text
# Install the latest version of the plugin:
atlas plugin install mongodb/atlas-cli-plugin-example
atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example
```

--------------------------------

### Install specific plugin version

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-plugin-install

Examples of installing a specific version of a plugin by appending the version identifier.

```text
# Install a specific version of the plugin:
atlas plugin install mongodb/atlas-cli-plugin-example@1.0.4
atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example/@v1.2.3
```

--------------------------------

### Atlas Setup Command Output

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-quickstart

Example output showing the cluster deployment process and connection details.

```sh
We are deploying Cluster9876543...

Please store your database authentication access details in a secure location
Database User Username: Cluster9876543
Database User Password: abcdef12345

Creating your cluster... [Its safe to 'Ctrl + C']
Cluster created.
Your connection string: mongodb+srv://cluster9876543.example.mongodb.net

Loading sample data into your cluster... [Its safe to 'Ctrl + C']

Now you can connect to your Atlas cluster with: mongosh -u Cluster9876543 -p abcdef12345 mongodb+srv://cluster9876543.example.mongodb.net
```

--------------------------------

### Start a local deployment syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-local-start

The basic command structure for starting a local deployment.

```text
atlas local start <deployment_name> [options]
```

--------------------------------

### List Clusters Examples

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-list

Examples demonstrating how to list clusters with specific filters and output formats.

```bash
# Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3:
atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json
```

```bash
# Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3 and with independent shard scaling mode:
atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --autoScalingMode independentShardScaling --output json
```

```bash
# Return a JSON-formatted list of all Flex clusters for the project with ID 5e2211c17a3e5a48f5497de3:
atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --tier FLEX --output json
```

--------------------------------

### Create a project example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-projects-create

Example command to create a project with a specific organization ID and JSON output format.

```bash
# Create a project in the organization with the ID 5e2211c17a3e5a48f5497de3 using default alert settings:
atlas projects create my-project --orgId 5e2211c17a3e5a48f5497de3 --output json
```

--------------------------------

### Generate Kubernetes configuration examples

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-kubernetes-config-generate

Various examples for generating Kubernetes resources with different flags and configurations.

```bash
# Export Project, DatabaseUsers, Deployments resources for a specific project without connection and integration secrets:
atlas kubernetes config generate --projectId=<projectId>
```

```bash
# Export Project, DatabaseUsers, Deployments resources for a specific project, but use external IDs where supported:
atlas kubernetes config generate --projectId=<projectId> --independentResources
```

```bash
# Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets:
atlas kubernetes config generate --projectId=<projectId> --includeSecrets
```

```bash
# Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets to a specific namespace:
atlas kubernetes config generate --projectId=<projectId> --includeSecrets --targetNamespace=<namespace>
```

```bash
# Export Project, DatabaseUsers, DataFederations and specific Deployment resources for a specific project including connection and integration secrets to a specific namespace:
atlas kubernetes config generate --projectId=<projectId> --clusterName=<cluster-name-1, cluster-name-2> --includeSecrets --targetNamespace=<namespace>
```

```bash
# Export resources for a specific version of the Atlas Kubernetes Operator:
atlas kubernetes config generate --projectId=<projectId> --targetNamespace=<namespace> --operatorVersion=1.5.1
```

```bash
# Export Project, DatabaseUsers, Clusters and specific DataFederation resources for a specific project to a specific namespace:
atlas kubernetes config generate --projectId=<projectId> --dataFederationName=<data-federation-name-1, data-federation-name-2> --targetNamespace=<namespace>
```

--------------------------------

### Get Access History Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-accessTracking-getAccessHistoryCluster

Example usage of the command specifying the API version, cluster name, and group ID.

```bash
atlas api accessTracking getAccessHistoryCluster --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Start a deployment

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local

Starts a previously stopped local deployment.

```sh
atlas local start
```

--------------------------------

### Create API Key Examples

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-projects-apiKeys-create

Examples demonstrating how to create an API key with single or multiple roles assigned to a project.

```bash
# Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json
```

```bash
# Create an organization API key with the GROUP_SEARCH_INDEX_EDITOR and GROUP_DATABASE_ACCESS_ADMIN roles and assign it to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_SEARCH_INDEX_EDITOR,GROUP_DATABASE_ACCESS_ADMIN --output json
```

--------------------------------

### List organizations examples

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-organizations-list

Examples demonstrating how to list organizations with specific output formats and filters.

```bash
# Return a JSON-formatted list of all organizations:
atlas organizations list --output json
```

```bash
# Return a JSON-formatted list that includes the organizations named org1 and Org1, but doesn't return org123:
atlas organizations list --name org1 --output json
```

--------------------------------

### Syntax for atlas deployments start

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-deployments-start

The basic command structure for starting a deployment.

```text
atlas deployments start <deploymentName> [options]
```

--------------------------------

### Initialization Script Example

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-docker-compose

A bash script example for downloading and restoring sample data into the local Atlas cluster.

```bash
# init/init.sh
#!/bin/bash

curl -O https://atlas-education.s3.amazonaws.com/sampledata.archive
echo "Sample data downloaded."
mongorestore --uri "$CONNECTION_STRING" --archive=./sampledata.archive
echo "Sample data loaded successfully."
```

--------------------------------

### List Database User Certificates Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-x509Authentication-listDatabaseUserCerts

Example command to retrieve certificates for a specific user and project.

```shell
atlas api x509Authentication listDatabaseUserCerts --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --username [username]
```

--------------------------------

### Install Prerequisites

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Install the necessary gnupg and curl packages before proceeding with the installation.

```sh
sudo apt-get install gnupg curl
```

--------------------------------

### List Backup Snapshot Databases Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listBackupSnapshotDatabases

Example command to list databases for a specific cluster, project, and snapshot.

```shell
atlas api cloudBackups listBackupSnapshotDatabases --version preview --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId]
```

--------------------------------

### Get Backup Snapshot Database Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getBackupSnapshotDatabase

Example command to retrieve a database from a snapshot, requiring the group ID, cluster name, database name, and snapshot ID.

```shell
atlas api cloudBackups getBackupSnapshotDatabase --version preview --clusterName [clusterName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId]
```

--------------------------------

### Get Export Bucket Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getExportBucket

Example command to retrieve a specific export bucket by providing the version, export bucket ID, and group ID.

```shell
atlas api cloudBackups getExportBucket --version 2024-05-30 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Create a Team Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-teams-create

Example command to create a team named 'myTeam' with specific users and organization ID.

```text
# Create a team named myTeam in the organization with ID 5e2211c17a3e5a48f5497de3:
atlas teams create myTeam --username user1@example.com,user2@example.com --orgId 5e1234c17a3e5a48f5497de3 --output json
```

--------------------------------

### Install Docker Compose

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker

Install the Docker Compose tool using Homebrew.

```sh
brew install docker-compose
```

--------------------------------

### Install cosign

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker

Install the cosign tool to verify the image signature.

```sh
brew install cosign
```

--------------------------------

### Enable Custom DNS Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-customDns-aws-enable

Example command to enable custom DNS for a specific project ID.

```bash
# Enable the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe:
atlas customDns aws enable --projectId 618d48e05277a606ed2496fe
```

--------------------------------

### Start an online archive syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-onlineArchives-start

The basic command structure for starting an online archive.

```text
atlas clusters onlineArchives start <archiveId> [options]
```

--------------------------------

### Load Sample Data Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-sampleData-load

An example of how to load sample data into a cluster named myCluster with JSON output.

```text
# Load sample data into the cluster named myCluster:
atlas clusters sampleData load myCluster --output json
```

--------------------------------

### List Available Projects Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-listAvailableProjects

Example command to list projects for a specific organization using a defined API version.

```shell
atlas api cloudMigrationService listAvailableProjects --version 2023-01-01 --orgId 4888442a3354817a7320eb61
```

--------------------------------

### Invite User Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-organizations-invitations-invite

An example of inviting a user with a specific organization ID and role.

```bash
# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access:
atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json
```

--------------------------------

### Watch Command Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-onlineArchives-watch

An example of how to watch a specific online archive by ID and cluster name.

```text
atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample
```

--------------------------------

### Update a project example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-projects-update

An example command to update a project using a specific ID and a JSON configuration file.

```text
# Update a project with the ID 5e2211c17a3e5a48f5497de3 using the JSON file named myProject.json:
atlas projects update 5f4007f327a3bd7b6f4103c5 --file myProject.json --output json
```

--------------------------------

### List installed plugins

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-plugin-list

Displays the syntax for listing all installed plugins.

```text
atlas plugin list [options]
```

--------------------------------

### List Export Buckets Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-listExportBuckets

Example usage of the command specifying the API version and project group ID.

```shell
atlas api cloudBackups listExportBuckets --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Cutover Migration Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-cutoverMigration

Example command to initiate the cutover process using specific version, group, and migration IDs.

```shell
atlas api cloudMigrationService cutoverMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8
```

--------------------------------

### Verify Installation

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Run the atlas command to verify the installation was successful.

```sh
atlas
```

--------------------------------

### Examples of describing a stream instance

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-streams-instances-describe

Examples showing how to describe a stream instance by name, including an option for JSON output.

```bash
# Return an Atlas Stream Processing instance with a specific name:
atlas streams instance describe myProcessor
```

```bash
# Return a JSON-formatted Atlas Stream Processing instance with a specific name:
atlas streams instance describe myProcessor --output json
```

--------------------------------

### Update Cluster Configuration Examples

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-update

Various command-line examples for updating specific cluster attributes or using a configuration file.

```bash
# Update the tier for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50
```

```bash
# Replace tags cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag key1=value1
```

```bash
# Remove all tags from cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag =
```

```bash
# Update the disk size for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --diskSizeGB 20
```

```bash
# Update the MongoDB version for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --mdbVersion 5.0
```

```bash
# Use a configuration file named cluster-config.json to update a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --output json
```

--------------------------------

### Download audit logs example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-streams-instances-download

Example command to download audit logs for a specific processor instance within a project.

```bash
# Download the audit log file from the instance myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas streams instance download myProcessor --projectId 5e2211c17a3e5a48f5497de3
```

--------------------------------

### Command Syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-setup

Basic syntax for executing the setup command.

```text
atlas setup [options]
```

--------------------------------

### Describe Atlas User Examples

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-users-describe

Examples showing how to retrieve user details by ID or username in JSON format.

```bash
# Return the JSON-formatted details for the Atlas user with the ID 5dd56c847a3e5a1f363d424d:
atlas users describe --id 5dd56c847a3e5a1f363d424d --output json
```

```bash
# Return the JSON-formatted details for the Atlas user with the username myUser:
atlas users describe --username myUser --output json
```

--------------------------------

### Install Atlas CLI

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Install the Atlas CLI package, optionally including mongosh.

```sh
sudo apt-get install -y mongodb-atlas
```

```sh
sudo apt-get install -y mongodb-atlas-cli
```

--------------------------------

### Install a custom plugin

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-extend-plugins

Use this command to install a plugin hosted on GitHub by specifying the owner and repository name.

```bash
atlas plugin install <github-owner>/<repository-name>
```

--------------------------------

### List Pinned Namespaces Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-listPinnedNamespaces

Example command to retrieve pinned namespaces for a specific cluster and project.

```shell
atlas api collectionLevelMetrics listPinnedNamespaces --version 2023-11-15 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Save LDAP Configuration Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-security-ldap-save

Example command to save an LDAP server configuration for authentication and authorization.

```text
# Save an LDAP server configuration to authenticate and authorize MongoDB users for the host atlas-ldaps-01.ldap.myteam.com:
atlas security ldap save --authenticationEnabled --authorizationEnabled
--hostname atlas-ldaps-01.ldap.myteam.com --bindUsername
"CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com"
--bindPassword changeMe
```

--------------------------------

### Get Cluster Namespaces Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getClusterNamespaces

Example command to retrieve cluster namespaces for a specific group and time period.

```shell
atlas api collectionLevelMetrics getClusterNamespaces --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --groupId 32b6e34b3d91647abb20e7b8 --period PT10H
```

--------------------------------

### atlas setup

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-setup

The atlas setup command is used to initialize an Atlas environment, including authentication and cluster creation.

```APIDOC
## atlas setup

### Description
This command takes you through login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell.

### Syntax
`atlas setup [options]`

### Options
- **--accessListIp** (strings) - Optional - IP address to grant access to the deployment. Mutually exclusive with --currentIp.
- **--autoScalingMode** (string) - Optional - Mode in which the cluster scales. Valid values are clusterWideScaling or independentShardScaling.
- **--clusterName** (string) - Optional - Name of the cluster.
- **--connectWith** (string) - Optional - Method for connecting to the cluster. Valid values are compass, mongosh, vscode and skip.
- **--currentIp** (flag) - Optional - Adds the IP address from the host that is currently executing the command to the access list.
- **--enableTerminationProtection** (flag) - Optional - Enables termination protection for your cluster.
- **--force** (flag) - Optional - Skips the request for input and creates a cluster with default settings.
- **--gov** (flag) - Optional - Login with Atlas for Government.
- **--mdbVersion** (string) - Optional - Major MongoDB version of the deployment.
- **--noBrowser** (flag) - Optional - Don't try to open a browser session.
- **--password** (string) - Optional - Password for the user.
- **--projectId** (string) - Optional - Hexadecimal string that identifies the project to use.
- **--provider** (string) - Optional - Name of your cloud service provider (AWS, AZURE, or GCP).
- **-r, --region** (string) - Optional - Physical location of your MongoDB cluster.
- **--skipSampleData** (flag) - Optional - Skips loading sample data into your MongoDB cluster.
- **--tag** (key=value) - Optional - List of key-value pairs for tagging and categorizing the cluster.
- **--tier** (string) - Optional - Tier for each data-bearing server in the cluster.
- **--username** (string) - Optional - Username for authenticating to MongoDB.

### Inherited Options
- **-P, --profile** (string) - Optional - Name of the profile to use from your configuration file.

### Example
`atlas setup --clusterName Test --provider GCP --username dbuserTest`
```

--------------------------------

### Get Organization Activity Feed Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-activityFeed-getOrgActivityFeed

Example usage of the command specifying the API version and organization ID.

```bash
atlas api activityFeed getOrgActivityFeed --version 2025-03-12 --orgId 4888442a3354817a7320eb61
```

--------------------------------

### Update project settings example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-projects-settings-update

An example of updating project settings using a specific profile and project ID.

```text
# This example uses the profile named "myprofile" for accessing Atlas.
atlas projects settings update --disableCollectDatabaseSpecificsStatistics -P myprofile --projectId 5e2211c17a3e5a48f5497de3
```

--------------------------------

### Watch Backup Restore Job Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-backups-exports-jobs-watch

Example command to monitor a specific backup restore job until it becomes available.

```text
# Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0 until it becomes available:
atlas backup restore watch 507f1f77bcf86cd799439011 --clusterName Cluster0
```

--------------------------------

### Get Cluster Details Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getCluster

Example command to retrieve details for a specific cluster using a defined API version.

```shell
atlas api clusters getCluster --version 2024-08-05 --clusterName [your-cluster-name] --groupId [your-project-id]
```

--------------------------------

### List Clusters Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-listClusters

Example command to list clusters for a specific project using a defined API version.

```shell
atlas api clusters listClusters --version 2024-08-05 --groupId [your-project-id]
```

--------------------------------

### Describe Database User Examples

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-dbusers-describe

Examples demonstrating how to describe users authenticated via SCRAM-SHA, AWS IAM, and X.509.

```text
# Return the details for the SCRAM SHA-authenticating database user named myDbUser:
atlas dbuser describe myDbUser --authDB admin --output json
```

```text
# Return the details for the AWS IAM-authenticating database user with the ARN arn:aws:iam::772401394250:user/my-test-user. Prepend $external with \ to escape the special-use character:
atlas dbuser describe arn:aws:iam::772401394250:user/my-test-user --authDB \$external --output json
```

```text
# Return the details for the X.509-authenticating database user with the RFC 2253 Distinguished Name CN=ellen@example.com,OU=users,DC=example,DC=com. Prepend $external with \ to escape the special-use character:
atlas dbuser describe CN=ellen@example.com,OU=users,DC=example,DC=com --authDB \$external --output json
```

--------------------------------

### Get Group Activity Feed Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-activityFeed-getGroupActivityFeed

Example usage of the command specifying the API version and project group ID.

```bash
atlas api activityFeed getGroupActivityFeed --version 2025-03-12 --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Get Restore Job Collection Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getRestoreJobCollection

Example command to retrieve a specific collection restore job using required identifiers.

```shell
atlas api cloudBackups getRestoreJobCollection --version preview --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --jobId [jobId] --sourceNamespace [sourceNamespace]
```

--------------------------------

### Command Syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-start

The basic structure for executing the start command.

```text
atlas clusters start <clusterName> [options]
```

--------------------------------

### Install Atlas CLI with Chocolatey

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Install the Atlas CLI package using the Chocolatey package manager.

```shell
choco install mongodb-atlas
```

--------------------------------

### Get Cluster Backup Snapshot Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getClusterBackupSnapshot

Example command to retrieve a specific snapshot using required identifiers and API version.

```shell
atlas api cloudBackups getClusterBackupSnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId]
```

--------------------------------

### Create Export Destination Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-backups-exports-buckets-create

Example command to create an export destination for an S3 bucket named test-bucket.

```text
# The following command creates an export destination for Atlas backups using the existing AWS S3 bucket named test-bucket:
atlas backup export buckets create test-bucket --cloudProvider AWS --iamRoleId 12345678f901a234dbdb00ca
```

--------------------------------

### Get Cluster Status Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-clusters-getClusterStatus

Example command to retrieve the status of a cluster using a specific API version, cluster name, and group ID.

```shell
atlas api clusters getClusterStatus --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Syntax for atlas deployments setup

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-deployments-setup

The basic command structure for setting up a deployment.

```text
atlas deployments setup [deploymentName] [options]
```

--------------------------------

### Get Migration Validation Status Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudMigrationService-getMigrationValidateStatus

Example command to retrieve the status of a migration validation job using specific group and validation IDs.

```shell
atlas api cloudMigrationService getMigrationValidateStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --validationId 507f1f77bcf86cd799439011
```

--------------------------------

### Create a project syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-projects-create

The basic command structure for creating a new project.

```text
atlas projects create <projectName> [options]
```

--------------------------------

### Get Backup Restore Job Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getBackupRestoreJob

Example command to retrieve a specific backup restore job using required identifiers and API version.

```shell
atlas api cloudBackups getBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId]
```

--------------------------------

### Describe project settings example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-projects-settings-describe

Retrieve settings for a specific project using a named profile.

```bash
# This example uses the profile named "myprofile" for accessing Atlas.
atlas projects settings describe -P myprofile --projectId 5e2211c17a3e5a48f5497de3
```

--------------------------------

### Get Backup Private Endpoint Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getBackupPrivateEndpoint

Example command to retrieve a backup private endpoint using specific cloud provider, endpoint ID, and group ID parameters.

```shell
atlas api cloudBackups getBackupPrivateEndpoint --version 2024-11-13 --cloudProvider [cloudProvider] --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Install Atlas CLI via Yum

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Install the Atlas CLI package using the Yum package manager.

```sh
sudo yum install -y mongodb-atlas
```

```sh
sudo yum install -y mongodb-atlas-cli
```

--------------------------------

### Create a search node example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-search-nodes-create

Example command to create a search node for a cluster named myCluster using a configuration file.

```text
# Create a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json:
atlas clusters search nodes create --clusterName myCluster --file spec.json --output json
```

--------------------------------

### Get Snapshot Database Collection Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getSnapshotDatabaseCollection

Retrieves a specific collection from a database snapshot using the required identifiers.

```shell
atlas api cloudBackups getSnapshotDatabaseCollection --version preview --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId]
```

--------------------------------

### Configure Yum Repository

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Create this file in /etc/yum.repos.d/ to enable installation via Yum.

```text
[mongodb-org-7.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/7.0/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/server-7.0.asc
```

--------------------------------

### Initialize Local Atlas Deployment

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local

Commands to start the local setup process with optional data loading or custom initialization.

```sh
atlas local setup
```

```sh
atlas local setup --loadSampleData true
```

```sh
atlas local setup --initdb {folder}
```

--------------------------------

### Configure Yum Repository

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Create a repository file to enable direct installation via Yum.

```text
[mongodb-enterprise-7.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.com/yum/redhat/$releasever/mongodb-enterprise/7.0/$basearch/
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/server-7.0.asc
```

--------------------------------

### Get Process Namespaces Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-collectionLevelMetrics-getProcessNamespaces

Retrieves namespaces for a specific process over a 10-hour period using the specified API version.

```shell
atlas api collectionLevelMetrics getProcessNamespaces --version 2023-11-15 --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017
```

--------------------------------

### Configure MongoDB Yum Repository

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Create this file at /etc/yum.repos.d/mongodb-org-7.0.repo to enable installation via Yum.

```text
[mongodb-org-7.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/amazon/2023/mongodb-org/7.0/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/server-7.0.asc
```

--------------------------------

### Configure Debian Repository

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Create the source list file for Debian 12 (Bookworm) to enable package installation.

```sh
echo "deb http://repo.mongodb.org/apt/debian bookworm/mongodb-org/7.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list
```

--------------------------------

### Get Backup Schedule Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-getBackupSchedule

Retrieves the backup schedule for a specified cluster using the provided project ID and API version.

```shell
atlas api cloudBackups getBackupSchedule --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
```

--------------------------------

### Example Project Creation Response

Source: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster

Shows the output format containing the project ID.

```text
Project '64933bde48add154124e343f' created.
```

--------------------------------

### Verify Atlas CLI Version

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Check the currently installed version of the Atlas CLI.

```sh
atlas --version
```

--------------------------------

### Configure Yum Repository for MongoDB Enterprise

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Create this file at /etc/yum.repos.d/mongodb-enterprise-7.0.repo to enable direct installation via Yum.

```text
[mongodb-enterprise-7.0]
name=MongoDB Enterprise Repository
baseurl=https://repo.mongodb.com/yum/amazon/2023/mongodb-enterprise/7.0/$basearch/
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/server-7.0.asc
```

--------------------------------

### Override Default Cluster Settings

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-setup

Example of using command options to specify cluster name, cloud provider, and database username during setup.

```text
# Override default cluster settings like name, provider, or database username by using the command options
atlas setup --clusterName Test --provider GCP --username dbuserTest
```

--------------------------------

### Command Syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-backups-compliancePolicy-setup

The basic syntax for executing the backup compliance policy setup command.

```text
atlas backups compliancePolicy setup [options]
```

--------------------------------

### Update Atlas CLI via Yum

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Update the installed Atlas CLI package using Yum.

```sh
yum update mongodb-atlas
```

```sh
yum update mongodb-atlas-cli
```

--------------------------------

### Update Atlas CLI with Chocolatey

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Use the Chocolatey package manager to upgrade the Atlas CLI installation.

```shell
choco upgrade mongodb-atlas
```

--------------------------------

### List Instances Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-streams-instances-list

Retrieve a JSON-formatted list of instances for a specific project ID.

```bash
# Return a JSON-formatted list of all Atlas Stream Processing instances for the project with ID 5e2211c17a3e5a48f5497de3:
atlas streams instance list --projectId 5e2211c17a3e5a48f5497de3 --output json
```

--------------------------------

### Update Atlas CLI with Homebrew

Source: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli

Use these commands to update the Atlas CLI and mongosh via Homebrew, depending on the package name used during initial installation.

```sh
brew update
brew upgrade mongodb-atlas-cli
```

```sh
brew update
brew upgrade mongodb-atlas
```

--------------------------------

### atlas local start

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-local-start

Starts a local MongoDB deployment by name.

```APIDOC
## atlas local start

### Description
Starts a local MongoDB deployment. This command requires the name of the deployment to be specified.

### Syntax
`atlas local start <deployment_name> [options]`

### Arguments
- **deployment_name** (string) - Required - Name of the deployment to start

### Options
- **--waitForHealthy** (flag) - Optional - Indicates whether to wait for the deployment to be healthy before returning
- **--waitForHealthyTimeout** (string) - Optional - Timeout for the wait for healthy deployment (e.g., 10s, 1m)
- **-o, --output** (string) - Optional - Output format
- **-P, --profile** (string) - Optional - Name of the profile to use from your configuration file
- **-h, --help** (flag) - Optional - Help for start
```

--------------------------------

### atlas clusters start

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-start

Starts a specified paused MongoDB cluster.

```APIDOC
## atlas clusters start

### Description
Starts the specified paused MongoDB cluster. This command is supported only for M10+ clusters and requires the Project Cluster Manager role.

### Syntax
`atlas clusters start <clusterName> [options]`

### Arguments
- **clusterName** (string) - Required - Name of the cluster to start.

### Options
- **--autoScalingMode** (string) - Optional - Mode in which the cluster scales (clusterWideScaling or independentShardScaling).
- **--projectId** (string) - Optional - Hexadecimal string that identifies the project to use.
- **-o, --output** (string) - Optional - Output format (json, json-path, go-template, or go-template-file).
- **-P, --profile** (string) - Optional - Name of the profile to use from your configuration file.

### Example
`atlas clusters start myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json`
```

--------------------------------

### List Projects in JSON Format

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-projects-list

Example command to retrieve all projects formatted as JSON.

```bash
# Return a JSON-formatted list of all projects:
atlas projects list --output json
```

--------------------------------

### Rename a profile example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-config-rename

An example of renaming a profile from 'myProfile' to 'testProfile'.

```text
# Rename a profile called myProfile to testProfile:
atlas config rename myProfile testProfile
```

--------------------------------

### Command Syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-backups-exports-buckets-create

The basic structure for executing the bucket creation command.

```text
atlas backups exports buckets create <bucketName> [options]
```

--------------------------------

### Atlas Local Setup Syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-local-setup

The basic syntax for initializing a local deployment using the Atlas CLI.

```text
atlas local setup [deployment_name] [options]
```

--------------------------------

### Install plugin syntax

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-plugin-install

General syntax for the atlas plugin install command.

```text
atlas plugin install [<github-owner>/<github-repository-name>] [options]
```

--------------------------------

### Download Restore Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-backups-restores-start

Initiates a download restore job for a specific snapshot.

```bash
atlas backup restore start download \
--clusterName myDemo \
--snapshotId 5e7e00128f8ce03996a47179
```

--------------------------------

### List Disks and Partitions Example

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-metrics-disks-list

Retrieves a JSON-formatted list of disks and partitions for a specific host.

```text
# Return a JSON-formatted list of disks and partitions for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017
atlas metrics disks list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json
```

--------------------------------

### atlas clusters onlineArchives start

Source: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-clusters-onlineArchives-start

Starts a paused online archive for a specific cluster.

```APIDOC
## atlas clusters onlineArchives start

### Description
Starts a paused online archive from a cluster.

### Syntax
`atlas clusters onlineArchives start <archiveId> [options]`

### Arguments
- **archiveId** (string) - Required - Unique identifier of the online archive to start.

### Options
- **--clusterName** (string) - Required - Name of the cluster.
- **--projectId** (string) - Optional - Hexadecimal string that identifies the project to use.
- **-o, --output** (string) - Optional - Output format (json, json-path, go-template, or go-template-file).
- **-P, --profile** (string) - Optional - Name of the profile to use from your configuration file.

### Output
If the command succeeds, the CLI returns: `Online archive '<Id>' started.`
```
Tokens:
Raw