Docs Menu
Docs Home
/ /
Atlas Command Line Interface
/ / /

atlas backups snapshots list

Return all cloud backup snapshots for your project and cluster.

atlas backups snapshots list <clusterName> [options]
Name
Type
Required
Description

clusterName

string

true

Name of the Atlas cluster that contains the snapshots you want to retrieve.

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.

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.

# Return a JSON-formatted list of snapshots for the cluster named myDemo
atlas backups snapshots list myDemo --output json

Back

describe

On this page