Docs Home → Atlas Command Line Interface
atlas serverless backups snapshots list
On this page
Return all cloud backup snapshots for the specified serverless instance in your project.
To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.
Syntax
atlas serverless backups snapshots list <clusterName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
clusterName | string | true | Label that identifies the Atlas serverless instance that contains the snapshots you want to return. |
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 instance named myDemo atlas serverless backups snapshots list myDemo --output json