Manual Pages

Explore documentation for 400+ CLI tools

Menu

atlas
atlas config

atlas config
atlas config init
atlas config set
atlas config ls
atlas config get
atlas config mv
atlas config rm

atlas auth

atlas auth
atlas auth login
atlas auth whoami
atlas auth logout

atlas quickstart
atlas project

atlas project
atlas project ls
atlas project create
atlas project rm
atlas project show
atlas project apikeys

atlas project apikeys
atlas project apikeys ls
atlas project apikeys create
atlas project apikeys rm
atlas project apikeys update

atlas project user

atlas project user
atlas project user ls
atlas project user rm

atlas project team

atlas project team
atlas project team ls
atlas project team add
atlas project team rm
atlas project team updates

atlas project invitation

atlas project invitation
atlas project invitation ls
atlas project invitation get
atlas project invitation rm
atlas project invitation create
atlas project invitation updates

atlas organization

atlas organization
atlas organization ls
atlas organization show
atlas organization create
atlas organization rm
atlas organization apikeys

atlas organization apikeys
atlas organization apikeys ls
atlas organization apikeys show
atlas organization apikeys updates
atlas organization apikeys create
atlas organization apikeys rm
atlas organization apikeys accesslists

atlas organization apikeys accesslists
atlas organization apikeys accesslists ls
atlas organization apikeys accesslists create
atlas organization apikeys accesslists rm

atlas organization user

atlas organization user
atlas organization user ls

atlas organization invitation

atlas organization invitation
atlas organization invitation ls
atlas organization invitation get
atlas organization invitation rm
atlas organization invitation updates
atlas organization invitation create

atlas globalapikeys

atlas globalapikeys
atlas globalapikeys ls
atlas globalapikeys show
atlas globalapikeys create
atlas globalapikeys update
atlas globalapikeys rm

atlas globalaccesslists

atlas globalaccesslists
atlas globalaccesslists ls
atlas globalaccesslists show
atlas globalaccesslists create
atlas globalaccesslists rm

atlas user

atlas user
atlas user invite
atlas user get
atlas user rm

atlas team

atlas team
atlas team ls
atlas team get
atlas team create
atlas team user

atlas team user
atlas team user ls
atlas team user add
atlas team user rm

atlas team rm

atlas cluster

atlas cluster
atlas cluster ls
atlas cluster get
atlas cluster create
atlas cluster watch
atlas cluster update
atlas cluster pause
atlas cluster start
atlas cluster rm
atlas cluster loadSampleData
atlas cluster index

atlas cluster index
atlas cluster index create

atlas cluster fts

atlas cluster fts
atlas cluster fts index

atlas cluster fts index
atlas cluster fts index ls
atlas cluster fts index create
atlas cluster fts index describe
atlas cluster fts index update
atlas cluster fts index rm

atlas cluster onlinearchives

atlas cluster onlinearchives
atlas cluster onlinearchives ls
atlas cluster onlinearchives describe
atlas cluster onlinearchives create
atlas cluster onlinearchives update
atlas cluster onlinearchives start
atlas cluster onlinearchives pause
atlas cluster onlinearchives rm
atlas cluster onlinearchives watch

atlas cluster connectionstrings

atlas cluster connectionstrings
atlas cluster connectionstrings get

atlas cluster availableregions

atlas cluster availableregions
atlas cluster availableregions ls

atlas dbuser

atlas dbuser
atlas dbuser ls
atlas dbuser get
atlas dbuser create
atlas dbuser rm
atlas dbuser update
atlas dbuser cert

atlas dbuser cert
atlas dbuser cert ls
atlas dbuser cert create

atlas customdbroles

atlas customdbroles
atlas customdbroles create
atlas customdbroles get
atlas customdbroles ls
atlas customdbroles rm
atlas customdbroles update

atlas accesslists

atlas accesslists
atlas accesslists get
atlas accesslists ls
atlas accesslists create
atlas accesslists rm

atlas datalakes

atlas datalakes
atlas datalakes ls
atlas datalakes describe
atlas datalakes create
atlas datalakes rm
atlas datalakes update

atlas alert

atlas alert
atlas alert config

atlas alert config
atlas alert config create
atlas alert config ls
atlas alert config rm
atlas alert config field

atlas alert config field
atlas alert config field types

atlas alert config update

atlas alert get
atlas alert ls
atlas alert ack
atlas alert unack
atlas alert global

atlas alert global
atlas alert global ls

atlas backup

atlas backup
atlas backup snapshot

atlas backup snapshot
atlas backup snapshot ls
atlas backup snapshot take
atlas backup snapshot describe
atlas backup snapshot watch
atlas backup snapshot rm

atlas backup restore

atlas backup restore
atlas backup restore ls
atlas backup restore start

atlas event

atlas event
atlas event ls
atlas event organization

atlas event organization
atlas event organization ls

atlas event project

atlas event project
atlas event project ls

atlas metric

atlas metric
atlas metric process
atlas metric disk

atlas metric disk
atlas metric disk ls
atlas metric disk describe

atlas metric database

atlas metric database
atlas metric database ls
atlas metric database describe

atlas performanceadvisor

atlas performanceadvisor
atlas performanceadvisor namespace

atlas performanceadvisor namespace
atlas performanceadvisor namespace ls

atlas performanceadvisor slowquerylogs

atlas performanceadvisor slowquerylogs
atlas performanceadvisor slowquerylogs ls

atlas performanceadvisor suggestedindexes

atlas performanceadvisor suggestedindexes
atlas performanceadvisor suggestedindexes ls

atlas performanceadvisor slowOT

atlas performanceadvisor slowOT
atlas performanceadvisor slowOT ls
atlas performanceadvisor slowOT disable

atlas log

atlas log
atlas log download

atlas process

atlas process
atlas process ls

atlas privateendpoints

atlas privateendpoints
atlas privateendpoints ls
atlas privateendpoints get
atlas privateendpoints create
atlas privateendpoints rm
atlas privateendpoints watch
atlas privateendpoints interface

atlas privateendpoints interface
atlas privateendpoints interface add
atlas privateendpoints interface get
atlas privateendpoints interface rm

atlas privateendpoints aws

atlas privateendpoints aws
atlas privateendpoints aws ls
atlas privateendpoints aws get
atlas privateendpoints aws create
atlas privateendpoints aws rm
atlas privateendpoints aws watch
atlas privateendpoints aws interface

atlas privateendpoints aws interface
atlas privateendpoints aws interface add
atlas privateendpoints aws interface get
atlas privateendpoints aws interface rm

atlas privateendpoints azure

atlas privateendpoints azure
atlas privateendpoints azure ls
atlas privateendpoints azure get
atlas privateendpoints azure create
atlas privateendpoints azure rm
atlas privateendpoints azure watch
atlas privateendpoints azure interface

atlas privateendpoints azure interface
atlas privateendpoints azure interface add
atlas privateendpoints azure interface get
atlas privateendpoints azure interface rm

atlas privateendpoints gcp

atlas privateendpoints gcp
atlas privateendpoints gcp create
atlas privateendpoints gcp rm
atlas privateendpoints gcp ls
atlas privateendpoints gcp get
atlas privateendpoints gcp watch
atlas privateendpoints gcp interface

atlas privateendpoints gcp interface
atlas privateendpoints gcp interface get
atlas privateendpoints gcp interface rm
atlas privateendpoints gcp interface add

atlas privateendpoints regionalmodes

atlas privateendpoints regionalmodes
atlas privateendpoints regionalmodes enable
atlas privateendpoints regionalmodes disable
atlas privateendpoints regionalmodes get

atlas privateendpoints datalakes

atlas privateendpoints datalakes
atlas privateendpoints datalakes aws

atlas privateendpoints datalakes aws
atlas privateendpoints datalakes aws create
atlas privateendpoints datalakes aws ls
atlas privateendpoints datalakes aws get
atlas privateendpoints datalakes aws rm

atlas privateendpoints onlinearchive

atlas privateendpoints onlinearchive
atlas privateendpoints onlinearchive aws

atlas privateendpoints onlinearchive aws
atlas privateendpoints onlinearchive aws create
atlas privateendpoints onlinearchive aws ls
atlas privateendpoints onlinearchive aws get
atlas privateendpoints onlinearchive aws rm

atlas networking

atlas networking
atlas networking container

atlas networking container
atlas networking container ls
atlas networking container rm

atlas networking peering

atlas networking peering
atlas networking peering ls
atlas networking peering create

atlas networking peering create
atlas networking peering create azure
atlas networking peering create aws
atlas networking peering create gcp

atlas networking peering watch
atlas networking peering rm

atlas security

atlas security
atlas security customercerts

atlas security customercerts
atlas security customercerts describe
atlas security customercerts create
atlas security customercerts disable

atlas security ldap

atlas security ldap
atlas security ldap verify

atlas security ldap verify
atlas security ldap verify status

atlas security ldap verify status
atlas security ldap verify status watch

atlas security ldap save
atlas security ldap rm
atlas security ldap get

atlas integration

atlas integration
atlas integration update

atlas integration update
atlas integration update new_relic
atlas integration update ops_genie
atlas integration update pager_duty
atlas integration update datadog
atlas integration update victor_ops
atlas integration update flowdock
atlas integration update webhook

atlas integration ls
atlas integration rm
atlas integration describe

atlas maintenancewindows

atlas maintenancewindows
atlas maintenancewindows update
atlas maintenancewindows rm
atlas maintenancewindows defer
atlas maintenancewindows get

atlas customdns

atlas customdns
atlas customdns aw

atlas customdns aw
atlas customdns aw enable
atlas customdns aw disable
atlas customdns aw get

atlas cloudproviders

atlas cloudproviders
atlas cloudproviders accessroles

atlas cloudproviders accessroles
atlas cloudproviders accessroles aws

atlas cloudproviders accessroles aws
atlas cloudproviders accessroles aws create
atlas cloudproviders accessroles aws authorize
atlas cloudproviders accessroles aws deauthorize

atlas cloudproviders accessroles ls

atlas sl

atlas sl
atlas sl ls
atlas sl get
atlas sl rm
atlas sl create
atlas sl watch

atlas livemigrations

atlas livemigrations
atlas livemigrations link

atlas livemigrations link
atlas livemigrations link create
atlas livemigrations link rm

atlas livemigrations validation

atlas livemigrations validation
atlas livemigrations validation create
atlas livemigrations validation get

atlas livemigrations create
atlas livemigrations get
atlas livemigrations cutover

atlas accesslogs

atlas accesslogs
atlas accesslogs ls

atlas login
atlas logout
atlas whoami
atlas completion

atlas completion
atlas completion bash
atlas completion zsh
atlas completion fish
atlas completion powershell

atlas help

atlas help
atlas help config

atlas help config
atlas help config init
atlas help config set
atlas help config ls
atlas help config get
atlas help config mv
atlas help config rm

atlas help auth

atlas help auth
atlas help auth login
atlas help auth whoami
atlas help auth logout

atlas help quickstart
atlas help project

atlas help project
atlas help project ls
atlas help project create
atlas help project rm
atlas help project show
atlas help project apikeys

atlas help project apikeys
atlas help project apikeys ls
atlas help project apikeys create
atlas help project apikeys rm
atlas help project apikeys update

atlas help project user

atlas help project user
atlas help project user ls
atlas help project user rm

atlas help project team

atlas help project team
atlas help project team ls
atlas help project team add
atlas help project team rm
atlas help project team updates

atlas help project invitation

atlas help project invitation
atlas help project invitation ls
atlas help project invitation get
atlas help project invitation rm
atlas help project invitation create
atlas help project invitation updates

atlas help organization

atlas help organization
atlas help organization ls
atlas help organization show
atlas help organization create
atlas help organization rm
atlas help organization apikeys

atlas help organization apikeys
atlas help organization apikeys ls
atlas help organization apikeys show
atlas help organization apikeys updates
atlas help organization apikeys create
atlas help organization apikeys rm
atlas help organization apikeys accesslists

atlas help organization apikeys accesslists
atlas help organization apikeys accesslists ls
atlas help organization apikeys accesslists create
atlas help organization apikeys accesslists rm

atlas help organization user

atlas help organization user
atlas help organization user ls

atlas help organization invitation

atlas help organization invitation
atlas help organization invitation ls
atlas help organization invitation get
atlas help organization invitation rm
atlas help organization invitation updates
atlas help organization invitation create

atlas help globalapikeys

atlas help globalapikeys
atlas help globalapikeys ls
atlas help globalapikeys show
atlas help globalapikeys create
atlas help globalapikeys update
atlas help globalapikeys rm

atlas help globalaccesslists

atlas help globalaccesslists
atlas help globalaccesslists ls
atlas help globalaccesslists show
atlas help globalaccesslists create
atlas help globalaccesslists rm

atlas help user

atlas help user
atlas help user invite
atlas help user get
atlas help user rm

atlas help team

atlas help team
atlas help team ls
atlas help team get
atlas help team create
atlas help team user

atlas help team user
atlas help team user ls
atlas help team user add
atlas help team user rm

atlas help team rm

atlas help cluster

atlas help cluster
atlas help cluster ls
atlas help cluster get
atlas help cluster create
atlas help cluster watch
atlas help cluster update
atlas help cluster pause
atlas help cluster start
atlas help cluster rm
atlas help cluster loadSampleData
atlas help cluster index

atlas help cluster index
atlas help cluster index create

atlas help cluster fts

atlas help cluster fts
atlas help cluster fts index

atlas help cluster fts index
atlas help cluster fts index ls
atlas help cluster fts index create
atlas help cluster fts index describe
atlas help cluster fts index update
atlas help cluster fts index rm

atlas help cluster onlinearchives

atlas help cluster onlinearchives
atlas help cluster onlinearchives ls
atlas help cluster onlinearchives describe
atlas help cluster onlinearchives create
atlas help cluster onlinearchives update
atlas help cluster onlinearchives start
atlas help cluster onlinearchives pause
atlas help cluster onlinearchives rm
atlas help cluster onlinearchives watch

atlas help cluster connectionstrings

atlas help cluster connectionstrings
atlas help cluster connectionstrings get

atlas help cluster availableregions

atlas help cluster availableregions
atlas help cluster availableregions ls

atlas help dbuser

atlas help dbuser
atlas help dbuser ls
atlas help dbuser get
atlas help dbuser create
atlas help dbuser rm
atlas help dbuser update
atlas help dbuser cert

atlas help dbuser cert
atlas help dbuser cert ls
atlas help dbuser cert create

atlas help customdbroles

atlas help customdbroles
atlas help customdbroles create
atlas help customdbroles get
atlas help customdbroles ls
atlas help customdbroles rm
atlas help customdbroles update

atlas help accesslists

atlas help accesslists
atlas help accesslists get
atlas help accesslists ls
atlas help accesslists create
atlas help accesslists rm

atlas help datalakes

atlas help datalakes
atlas help datalakes ls
atlas help datalakes describe
atlas help datalakes create
atlas help datalakes rm
atlas help datalakes update

atlas help alert

atlas help alert
atlas help alert config

atlas help alert config
atlas help alert config create
atlas help alert config ls
atlas help alert config rm
atlas help alert config field

atlas help alert config field
atlas help alert config field types

atlas help alert config update

atlas help alert get
atlas help alert ls
atlas help alert ack
atlas help alert unack
atlas help alert global

atlas help alert global
atlas help alert global ls

atlas help backup

atlas help backup
atlas help backup snapshot

atlas help backup snapshot
atlas help backup snapshot ls
atlas help backup snapshot take
atlas help backup snapshot describe
atlas help backup snapshot watch
atlas help backup snapshot rm

atlas help backup restore

atlas help backup restore
atlas help backup restore ls
atlas help backup restore start

atlas help event

atlas help event
atlas help event ls
atlas help event organization

atlas help event organization
atlas help event organization ls

atlas help event project

atlas help event project
atlas help event project ls

atlas help metric

atlas help metric
atlas help metric process
atlas help metric disk

atlas help metric disk
atlas help metric disk ls
atlas help metric disk describe

atlas help metric database

atlas help metric database
atlas help metric database ls
atlas help metric database describe

atlas help performanceadvisor

atlas help performanceadvisor
atlas help performanceadvisor namespace

atlas help performanceadvisor namespace
atlas help performanceadvisor namespace ls

atlas help performanceadvisor slowquerylogs

atlas help performanceadvisor slowquerylogs
atlas help performanceadvisor slowquerylogs ls

atlas help performanceadvisor suggestedindexes

atlas help performanceadvisor suggestedindexes
atlas help performanceadvisor suggestedindexes ls

atlas help performanceadvisor slowOT

atlas help performanceadvisor slowOT
atlas help performanceadvisor slowOT ls
atlas help performanceadvisor slowOT disable

atlas help log

atlas help log
atlas help log download

atlas help process

atlas help process
atlas help process ls

atlas help privateendpoints

atlas help privateendpoints
atlas help privateendpoints ls
atlas help privateendpoints get
atlas help privateendpoints create
atlas help privateendpoints rm
atlas help privateendpoints watch
atlas help privateendpoints interface

atlas help privateendpoints interface
atlas help privateendpoints interface add
atlas help privateendpoints interface get
atlas help privateendpoints interface rm

atlas help privateendpoints aws

atlas help privateendpoints aws
atlas help privateendpoints aws ls
atlas help privateendpoints aws get
atlas help privateendpoints aws create
atlas help privateendpoints aws rm
atlas help privateendpoints aws watch
atlas help privateendpoints aws interface

atlas help privateendpoints aws interface
atlas help privateendpoints aws interface add
atlas help privateendpoints aws interface get
atlas help privateendpoints aws interface rm

atlas help privateendpoints azure

atlas help privateendpoints azure
atlas help privateendpoints azure ls
atlas help privateendpoints azure get
atlas help privateendpoints azure create
atlas help privateendpoints azure rm
atlas help privateendpoints azure watch
atlas help privateendpoints azure interface

atlas help privateendpoints azure interface
atlas help privateendpoints azure interface add
atlas help privateendpoints azure interface get
atlas help privateendpoints azure interface rm

atlas help privateendpoints gcp

atlas help privateendpoints gcp
atlas help privateendpoints gcp create
atlas help privateendpoints gcp rm
atlas help privateendpoints gcp ls
atlas help privateendpoints gcp get
atlas help privateendpoints gcp watch
atlas help privateendpoints gcp interface

atlas help privateendpoints gcp interface
atlas help privateendpoints gcp interface get
atlas help privateendpoints gcp interface rm
atlas help privateendpoints gcp interface add

atlas help privateendpoints regionalmodes

atlas help privateendpoints regionalmodes
atlas help privateendpoints regionalmodes enable
atlas help privateendpoints regionalmodes disable
atlas help privateendpoints regionalmodes get

atlas help privateendpoints datalakes

atlas help privateendpoints datalakes
atlas help privateendpoints datalakes aws

atlas help privateendpoints datalakes aws
atlas help privateendpoints datalakes aws create
atlas help privateendpoints datalakes aws ls
atlas help privateendpoints datalakes aws get
atlas help privateendpoints datalakes aws rm

atlas help privateendpoints onlinearchive

atlas help privateendpoints onlinearchive
atlas help privateendpoints onlinearchive aws

atlas help privateendpoints onlinearchive aws
atlas help privateendpoints onlinearchive aws create
atlas help privateendpoints onlinearchive aws ls
atlas help privateendpoints onlinearchive aws get
atlas help privateendpoints onlinearchive aws rm

atlas help networking

atlas help networking
atlas help networking container

atlas help networking container
atlas help networking container ls
atlas help networking container rm

atlas help networking peering

atlas help networking peering
atlas help networking peering ls
atlas help networking peering create

atlas help networking peering create
atlas help networking peering create azure
atlas help networking peering create aws
atlas help networking peering create gcp

atlas help networking peering watch
atlas help networking peering rm

atlas help security

atlas help security
atlas help security customercerts

atlas help security customercerts
atlas help security customercerts describe
atlas help security customercerts create
atlas help security customercerts disable

atlas help security ldap

atlas help security ldap
atlas help security ldap verify

atlas help security ldap verify
atlas help security ldap verify status

atlas help security ldap verify status
atlas help security ldap verify status watch

atlas help security ldap save
atlas help security ldap rm
atlas help security ldap get

atlas help integration

atlas help integration
atlas help integration update

atlas help integration update
atlas help integration update new_relic
atlas help integration update ops_genie
atlas help integration update pager_duty
atlas help integration update datadog
atlas help integration update victor_ops
atlas help integration update flowdock
atlas help integration update webhook

atlas help integration ls
atlas help integration rm
atlas help integration describe

atlas help maintenancewindows

atlas help maintenancewindows
atlas help maintenancewindows update
atlas help maintenancewindows rm
atlas help maintenancewindows defer
atlas help maintenancewindows get

atlas help customdns

atlas help customdns
atlas help customdns aw

atlas help customdns aw
atlas help customdns aw enable
atlas help customdns aw disable
atlas help customdns aw get

atlas help cloudproviders

atlas help cloudproviders
atlas help cloudproviders accessroles

atlas help cloudproviders accessroles
atlas help cloudproviders accessroles aws

atlas help cloudproviders accessroles aws
atlas help cloudproviders accessroles aws create
atlas help cloudproviders accessroles aws authorize
atlas help cloudproviders accessroles aws deauthorize

atlas help cloudproviders accessroles ls

atlas help sl

atlas help sl
atlas help sl ls
atlas help sl get
atlas help sl rm
atlas help sl create
atlas help sl watch

atlas help livemigrations

atlas help livemigrations
atlas help livemigrations link

atlas help livemigrations link
atlas help livemigrations link create
atlas help livemigrations link rm

atlas help livemigrations validation

atlas help livemigrations validation
atlas help livemigrations validation create
atlas help livemigrations validation get

atlas help livemigrations create
atlas help livemigrations get
atlas help livemigrations cutover

atlas help accesslogs

atlas help accesslogs
atlas help accesslogs ls

atlas help login
atlas help logout
atlas help whoami
atlas help completion

atlas help completion
atlas help completion bash
atlas help completion zsh
atlas help completion fish
atlas help completion powershell

atlas help cluster pause

Pause a running MongoDB cluster in Atlas

On this page

Edit this page on Github →

Products

Scripts
Autocomplete
Dotfiles & Secrets
Fig AI
Access
Plugin Store
Manual Pages

Social

Twitter
Github
Discord

Resources

User Manual
Documentation
Debug
Changelog

Company

We're hiring
Contact us
Privacy Policy
Blog

Backed By

Made with ❤️ in San Francisco
Copyright © 2023 Hercules Labs Inc.