Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas metrics databases list

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Return all databases running on the specified host for your project.

To return the hostname and port needed for this command, run atlas processes list

To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Command Syntax
atlas metrics databases list <hostname:port> [options]
Name
Type
Required
Description
hostname:port
string
true
Hostname and port number of the instance running the MongoDB process.
Name
Type
Required
Description
-h, --help
false
help for list
--limit
int
false
Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100.
--omitCount
false
Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--page
int
false
Page number that specifies a page of results. This value defaults to 1.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

DATABASE NAME
<DatabaseName>
# Return a JSON-formatted list of available databases for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017
atlas metrics databases list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json

Back

describe