Navigation

mongocli atlas backup snapshots describe

The backup snapshots describe command returns information about a specified backup snapshot. You can also retrieve information about a snapshot through the Atlas UI or API.

mongocli atlas backup snapshots describe <snapshot-id>
--clusterName <cluster-name>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
[ --projectId <project-ID> ]
Note

Use -h or --help to view the command-line help for this command.

Option
Type
Description
Required?
<snapshot-id>
string
Unique identifier of the snapshot.
yes
--clusterName
string
Name of the cluster.
yes
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using the Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string
Name of the profile where the project ID and the Programmatic API Keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no

If the command is successful, it returns the following information:

Field
Description
ID
Unique identifier of the snapshot.
SNAPSHOT-TYPE

Type of snapshot. Valid values include:

  • scheduled
  • onDemand
TYPE

Type of MongoDB cluster. Valid values include:

  • replicaSet
  • shardedCluster
DESCRIPTION
Description associated with this snapshot.
EXPIRES AT
Expiration date for this snapshot.

The following example uses the mongocli atlas backup snapshots describe command to retrieve information about a backup snapshot for the cluster named myDemo. The command uses the default profile, where the project ID and the Programmatic API Keys are stored.

mongocli atlas backups snapshots describe 5f4007f327a3bd7b6f4103c5 --clusterName myDemo

The command prints the following output to the terminal.

ID SNAPSHOT TYPE TYPE DESCRIPTION EXPIRES AT
5f4007f327a3bd7b6f4103c5 onDemand replicaSet "daily snap" 2020-08-24T17:53:03Z
Give Feedback