All apps/MongoDB Atlas CLI

MongoDB Atlas CLI

mongodb-atlas-cli

The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.

Runs as atlas|macOS, Linux, Windows|www.mongodb.com

Autocomplete

Fig spec, with what the manifest adds · 647 subcommands · 2 options
Published once and never changed; check the digest before caching
sha256
ada9d237b14622b090e4c8d6c9fac8911e9fdd892cb921235774344df56da0b5
Size
458971 bytes
Subcommands647 subcommands
atlas config
Manage your profile to store access settings for your MongoDB deployment
atlas config init
Configure a profile to store access settings for your MongoDB deployment
atlas config set
Configure specific properties of a profile
atlas config ls
List available profiles
atlas config get
Return a specific profile
atlas config mv
Rename a profile
atlas config rm
Delete a profile
atlas auth
Manage the CLI's authentication state
atlas auth login
Authenticate with MongoDB Atlas
atlas auth whoami
Verifies and displays information about your authentication state
atlas auth logout
Log out of the CLI
atlas quickstart
Create and access an Atlas Cluster
atlas project
Project operations
atlas project ls
List projects
atlas project create
Create a project
atlas project rm
Delete a project
atlas project show
Describe a project
atlas project apikeys
Manage API Keys for your project
atlas project apikeys ls
List API Keys for your project
atlas project apikeys create
Create an API Key for your project
atlas project apikeys rm
Delete an API Key for your project
atlas project apikeys update
Assign an API Key to a project
atlas project user
Manage users for a project
atlas project user ls
List all users for a project
atlas project user rm
Delete user from a project
atlas project team
Teams operations
atlas project team ls
Get all teams in a project
atlas project team add
Add team to a project
atlas project team rm
Delete team from a project
atlas project team updates
Update roles for a team in a project
atlas project invitation
Invitation operations
atlas project invitation ls
Retrieves all pending invitations to the specified project
atlas project invitation get
Retrieve details for one pending invitation to the specified project
atlas project invitation rm
Deletes one pending invitation to the specified project
atlas project invitation create
Invites one user to the project that you specify
atlas project invitation updates
Updates one pending invitation by invitationId or email to the project that you specify
atlas organization
Organization operations
atlas organization ls
List organizations
atlas organization show
Describe an organizations
atlas organization create
Create an organization
atlas organization rm
Delete an organization
atlas organization apikeys
Organization API Keys operations
atlas organization apikeys ls
List API Keys for your organization
atlas organization apikeys show
Get a specific Organization API Key
atlas organization apikeys updates
Update an Organization API Key
atlas organization apikeys create
Create an Organization API Key
atlas organization apikeys rm
Delete an Organization API Key
atlas organization apikeys accesslists
Manage the IP access list for your API Key
atlas organization apikeys accesslists ls
List IP access list entries for your API Key
atlas organization apikeys accesslists create
Create an IP access list for your API Key
atlas organization apikeys accesslists rm
Delete an IP access list from your API Key
atlas organization user
Users operations
atlas organization user ls
List users in a organization
atlas organization invitation
Invitation operations
atlas organization invitation ls
Retrieves all pending invitations to the specified organization
atlas organization invitation get
Retrieve details for one pending invitation to the specified organization
atlas organization invitation rm
Deletes one pending invitation to the specified organization
atlas organization invitation updates
Updates one pending invitation by invitationId or email to the project that you specify
atlas organization invitation create
Invites one user to the organization that you specify
atlas globalapikeys
Global API Keys operations
atlas globalapikeys ls
List Global API Keys
atlas globalapikeys show
Get a specific Global API Key
atlas globalapikeys create
Create a Global API Key
atlas globalapikeys update
Update a Global API Key
atlas globalapikeys rm
Delete a Global API Key
atlas globalaccesslists
Manage IP access list for Global API Key
atlas globalaccesslists ls
List Atlas IP access list entries for Global API Key
atlas globalaccesslists show
Return one Global IP access list entry
atlas globalaccesslists create
Create an IP access list for Global API Key
atlas globalaccesslists rm
Delete an IP access list from Global API Key
atlas user
Users operations
atlas user invite
Invite a user
atlas user get
Get a user by username or id
atlas user rm
Delete an Ops Manager user
atlas team
Teams operations
atlas team ls
Get all teams in an organization
atlas team get
Get a team in an organization
atlas team create
Create a team in an organization
atlas team user
Users operations
atlas team user ls
List users of a team
atlas team user add
Add a user to a team
atlas team user rm
Delete user from a team
atlas team rm
Delete a team from an organization
atlas cluster
Manage clusters for your project
atlas cluster ls
List clusters for your project
atlas cluster get
Describe a cluster
atlas cluster create
Create one cluster in the specified project
atlas cluster watch
Watch for a cluster to be available
atlas cluster update
Update a MongoDB cluster
atlas cluster pause
Pause a running MongoDB cluster in Atlas
atlas cluster start
Start a paused MongoDB cluster in Atlas
atlas cluster rm
Delete a cluster from your project
atlas cluster loadSampleData
Load sample data into a MongoDB cluster in Atlas
atlas cluster index
Manage cluster rolling indexes for your project
atlas cluster index create
Create a rolling index for your MongoDB cluster
atlas cluster fts
Manage Atlas Search for your cluster
atlas cluster fts index
Manage Atlas Search indexes for your cluster
atlas cluster fts index ls
List Atlas search indexes for a cluster
atlas cluster fts index create
Create a search index for a cluster
atlas cluster fts index describe
Describe a search index for a cluster
atlas cluster fts index update
Update a search index for a cluster
atlas cluster fts index rm
Delete a search index from a cluster
atlas cluster onlinearchives
Manage online archives for your cluster
atlas cluster onlinearchives ls
List online archives for a cluster
atlas cluster onlinearchives describe
Describe an online archive for a cluster
atlas cluster onlinearchives create
Create an online archive for a cluster
atlas cluster onlinearchives update
Update an online archive for a cluster
atlas cluster onlinearchives start
Start a paused online archive from a cluster
atlas cluster onlinearchives pause
Pause an online archive from a cluster
atlas cluster onlinearchives rm
Delete an online archive from a cluster
atlas cluster onlinearchives watch
Watch for an archive to be available
atlas cluster connectionstrings
Manage MongoDB cluster connection string
atlas cluster connectionstrings get
Retrieve the SRV connection string of your MongoDB cluster
atlas dbuser
Manage database users for your project
atlas dbuser ls
List Atlas database users for your project
atlas dbuser get
Return a single Atlas database user for your project
atlas dbuser create
Create a database user for your project
atlas dbuser rm
Delete a database user for your project
atlas dbuser update
Update a database user for your project
atlas dbuser cert
Manage Atlas x509 certificates for your database users
atlas dbuser cert ls
List of all Atlas-managed, unexpired certificates for a database user
atlas dbuser cert create
Create a new Atlas-managed X.509 certificate for the specified database user
atlas customdbroles
Manage custom database roles for your project
atlas customdbroles create
Create a custom database role for your project
atlas customdbroles get
Return a single custom database role for your project
atlas customdbroles ls
List custom database roles for your project
atlas customdbroles rm
Delete a custom database role for your project
atlas customdbroles update
Update a custom database role for your project
atlas accesslists
Manage the access IP access list for your project
atlas accesslists get
Describe an IP access list entry
atlas accesslists ls
List Atlas IP access list entries for your project
atlas accesslists create
Create an IP access list for your project
atlas accesslists rm
Delete an IP access list from your project
atlas datalakes
Manage Atlas Data Lakes for your project
atlas datalakes ls
List Atlas Data Lakes for your project
atlas datalakes describe
Return a specific data lake
atlas datalakes create
Create a new data lake for your project
atlas datalakes rm
Delete a data lake from your project
atlas datalakes update
Update a data lake for your project
atlas alert
Manage alerts for your project
atlas alert config
Manages alerts configuration for your project
atlas alert config create
Creates one alert configuration in the specified project
atlas alert config ls
Returns alert configurations for the specified project
atlas alert config rm
Deletes the specified alert configuration in a specified project
atlas alert config field
Manages alert configuration fields for your project
atlas alert config field types
Lists available field types for your alert configurations
atlas alert config update
Updates one alert configuration in the specified project
atlas alert get
Retrieves one alert for the specified project
atlas alert ls
Retrieves all alerts for the specified Atlas project
atlas alert ack
Acknowledges one alert for the specified project
atlas alert unack
Unacknowledges one alert for the specified project
atlas alert global
Retrieves all the global alerts for the specified Ops Manager project
atlas alert global ls
Returns all global alerts for the specified Ops Manager project
atlas backup
Manage cloud backups for your project
atlas backup snapshot
Manage cloud backup snapshots for your project
atlas backup snapshot ls
List cloud backup snapshots for your project and cluster
atlas backup snapshot take
Create a backup snapshot for your project and cluster
atlas backup snapshot describe
Get a specific snapshot for your project
atlas backup snapshot watch
Watch for a snapshot to be available
atlas backup snapshot rm
Delete a backup snapshot
atlas backup restore
Manage cloud backup restore jobs for your project
atlas backup restore ls
List cloud backup restore jobs for your project and cluster
atlas backup restore start
Start a restore job for your project and cluster
atlas event
Manage events for your organization or project
atlas event ls
Return all events for an organization or project
atlas event organization
Organization operations
atlas event organization ls
Return all events for an organization
atlas event project
Project operations
atlas event project ls
Return all events for a project
atlas metric
Get metrics on the MongoDB process
atlas metric process
Get MongoDB process metrics for a given host
atlas metric disk
List available disks or disk metrics for a given host
atlas metric disk ls
List available disks or disk partitions for a given host
atlas metric disk describe
Describe disk partition metrics for a disk partition on a specified host
atlas metric database
List available databases or database metrics for a given host
atlas metric database ls
List available databases or database metrics for a given host
atlas metric database describe
Describe database metrics for a database on a specific host
atlas performanceadvisor
Performance Advisor operations
atlas performanceadvisor namespace
Retrieve namespaces for collections experiencing slow queries
atlas performanceadvisor namespace ls
Retrieve up to 20 namespaces for collections experiencing slow queries for a specified host
atlas performanceadvisor slowquerylogs
Get log lines for slow queries for a specified host
atlas performanceadvisor slowquerylogs ls
Return log lines for slow queries that the Performance Advisor and Query Profiler identified
atlas performanceadvisor suggestedindexes
Get suggested indexes for collections experiencing slow queries
atlas performanceadvisor suggestedindexes ls
Retrieve suggested indexes for collections experiencing slow queries
atlas performanceadvisor slowOT
Enable or disable management of the slow operation threshold for your cluster
atlas performanceadvisor slowOT ls
Enable the application-managed slow operation threshold for your project
atlas performanceadvisor slowOT disable
Disable the application-managed slow operation threshold for your project
atlas log
Download host logs for your project
atlas log download
Download a host mongodb logs
atlas process
Manage MongoDB processes for your project
atlas process ls
List MongoDB processes for your project
atlas privateendpoints
Manage Atlas private endpoints
atlas privateendpoints ls
List Atlas Private Endpoints for your project
atlas privateendpoints get
Return a specific Private Endpoints for your project
atlas privateendpoints create
Create a new private endpoint for your project
atlas privateendpoints rm
Delete a private endpoint from your project
atlas privateendpoints watch
Watch for a private endpoint to be available
atlas privateendpoints interface
Manage Atlas private endpoint interfaces
atlas privateendpoints interface add
Add a new interface to a private endpoint
atlas privateendpoints interface get
Return a specific private endpoint interface for your project
atlas privateendpoints interface rm
Delete a private endpoint interface from your project
atlas privateendpoints aws
Manage AWS Private Endpoints
atlas privateendpoints aws ls
List AWS Private Endpoints for your project
atlas privateendpoints aws get
Return a specific AWS Private Endpoints for your project
atlas privateendpoints aws create
Create a new AWS Private Endpoint for your project
atlas privateendpoints aws rm
Delete a specific AWS Private Endpoint for your project
atlas privateendpoints aws watch
Watch for a specific AWS Private Endpoint to be available
atlas privateendpoints aws interface
Manage Atlas AWS private endpoint interfaces
atlas privateendpoints aws interface add
Add a new interface to a AWS private endpoint
atlas privateendpoints aws interface get
Return a specific AWS private endpoint interface for your project
atlas privateendpoints aws interface rm
Delete a specific AWS private endpoint interface and the related endpoint service for your project
atlas privateendpoints azure
Manage Azure Private Endpoints
atlas privateendpoints azure ls
List Azure Private Endpoints for your project
atlas privateendpoints azure get
Return a specific Azure Private Endpoints for your project
atlas privateendpoints azure create
Create a new Azure Private Endpoint for your project
atlas privateendpoints azure rm
Delete a specific Azure Private Endpoint for your project
atlas privateendpoints azure watch
Watch for a specific Azure Private Endpoint to be available
atlas privateendpoints azure interface
Manage Atlas Azure private endpoint interfaces
atlas privateendpoints azure interface add
Add a new Azure interface to a private endpoint
atlas privateendpoints azure interface get
Return a specific Azure private endpoint interface for your project
atlas privateendpoints azure interface rm
Delete a specific Azure private endpoint interface and related service for your project
atlas privateendpoints gcp
Manage GCP private endpoints
atlas privateendpoints gcp create
Create a new GCP private endpoint for your project
atlas privateendpoints gcp rm
Delete a GCP private endpoint for your project
atlas privateendpoints gcp ls
List GCP private endpoints for your project
atlas privateendpoints gcp get
Return a specific GCP private endpoint for your project
atlas privateendpoints gcp watch
Watch the specified GCP private endpoint to detect changes in the endpoint's state
atlas privateendpoints gcp interface
Manage Atlas GCP private endpoint interfaces
atlas privateendpoints gcp interface get
Return a specific GCP private endpoint interface for your project
atlas privateendpoints gcp interface rm
Delete a specific GCP private endpoint interface for your project
atlas privateendpoints gcp interface add
Create a GCP private endpoint interface
atlas privateendpoints regionalmodes
Manage regionalized private endpoint setting for your Atlas project
atlas privateendpoints regionalmodes enable
Enable the regionalized private endpoint setting for your Atlas project
atlas privateendpoints regionalmodes disable
Disable the regionalized private endpoint setting for your Atlas project
atlas privateendpoints regionalmodes get
Get the regionalized private endpoint setting for your Atlas project
atlas privateendpoints datalakes
Manage Data Lake private endpoints
atlas privateendpoints datalakes aws
Manage AWS private endpoints
atlas privateendpoints datalakes aws create
Create a new Data Lake private endpoint for your project
atlas privateendpoints datalakes aws ls
List Data Lake private endpoints for your project
atlas privateendpoints datalakes aws get
Return a specific Data Lake private endpoint for your project
atlas privateendpoints datalakes aws rm
Delete a specific Data Lake private endpoint for your project
atlas privateendpoints onlinearchive
Manage Online Archive private endpoints
atlas privateendpoints onlinearchive aws
Manage AWS private endpoints
atlas privateendpoints onlinearchive aws create
Create a new Data Lake private endpoint for your project
atlas privateendpoints onlinearchive aws ls
List Data Lake private endpoints for your project
atlas privateendpoints onlinearchive aws get
Return a specific Data Lake private endpoint for your project
atlas privateendpoints onlinearchive aws rm
Delete a specific Data Lake private endpoint for your project
atlas networking
Networking operations
atlas networking container
Manage Network Peering containers
atlas networking container ls
List network peering containers in an Atlas project
atlas networking container rm
Remove one network peering container in an Atlas project
atlas networking peering
Manage Network Peering connections
atlas networking peering ls
Retrieve details for all network peering connections in one Atlas project
atlas networking peering create
Create a connection with AWS, Azure and Google Cloud
atlas networking peering create azure
Create a connection with Azure
atlas networking peering create aws
Create a connection with AWS
atlas networking peering create gcp
Create a connection with GCP
atlas networking peering watch
Watch for a peering connection to be available
atlas networking peering rm
Delete a peering connection from an Atlas project
atlas security
Manage security configuration for your project
atlas security customercerts
Manage customer x509 certificates for your project
atlas security customercerts describe
Get the current customer-managed X.509 configuration details for an Atlas project
atlas security customercerts create
Saves a customer-managed X.509 configuration for an Atlas project
atlas security customercerts disable
Disables customer-managed X.509 for a project
atlas security ldap
LDAP operations
atlas security ldap verify
Request verification of an LDAP configuration
atlas security ldap verify status
Get the status of an LDAP configuration request
atlas security ldap verify status watch
Watch for an LDAP configuration request to complete
atlas security ldap save
Save an LDAP configuration
atlas security ldap rm
Delete an LDAP configuration userToDNMapping from an LDAP configuration
atlas security ldap get
Get an LDAP configuration
atlas integration
Third party integration operations
atlas integration update
Create operations
atlas integration update new_relic
Create or update the New Relic integration
atlas integration update ops_genie
Create or update the Ops Genie integration
atlas integration update pager_duty
Create or update the PagerDuty integration
atlas integration update datadog
Create or update the Datadog integration
atlas integration update victor_ops
Create or update the VictorOps integrations
atlas integration update flowdock
Create or update the Flowdock integration
atlas integration update webhook
Create or update the Webhook integration
atlas integration ls
List third party integrations
atlas integration rm
Delete a third party integration
atlas integration describe
Get a third party integration
atlas maintenancewindows
Manage Atlas maintenance windows
atlas maintenancewindows update
Update the maintenance window
atlas maintenancewindows rm
Clear the maintenance window
atlas maintenancewindows defer
Defer the maintenance window
atlas maintenancewindows get
Get a maintenance window
atlas customdns
Manage DNS configuration of Atlas project’s clusters deployed to AWS
atlas customdns aw
Manage DNS configuration of an Atlas project’s cluster deployed to AWS
atlas customdns aw enable
Enable the custom DNS configuration of an Atlas project’s cluster deployed to AWS
atlas customdns aw disable
Disable the custom DNS configuration of an Atlas project’s cluster deployed to AWS
atlas customdns aw get
Describe the custom DNS configuration of an Atlas project’s cluster deployed to AWS
atlas cloudproviders
Manage unified IAM role access in Atlas
atlas cloudproviders accessroles
Manage AWS IAM role access in Atlas
atlas cloudproviders accessroles aws
Manage AWS IAM role access in Atlas
atlas cloudproviders accessroles aws create
Create an AWS IAM role
atlas cloudproviders accessroles aws authorize
Authorize an AWS IAM role
atlas cloudproviders accessroles aws deauthorize
Deauthorize an AWS IAM role
atlas cloudproviders accessroles ls
List AWS IAM role access in Atlas
and 347 more — all of them are in the JSON
OptionsOn atlas itself
--profile-P
Profile to use from your configuration file <profile>
--help-h
Display help