Docs Home → MongoDB Command Line Interface
mongocli atlas backups snapshots list
On this page
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Return all cloud backup snapshots for your project and cluster.
To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.
Syntax
mongocli atlas backups snapshots list <clusterName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
clusterName | string | true | Name of the Atlas cluster that contains the snapshots you want to retrieve. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for list | |
--limit | int | false | Number of items per results page. This value defaults to 100. |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--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. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# Return a JSON-formatted list of snapshots for the cluster named myDemo mongocli atlas backups snapshots list myDemo --output json