Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas backups snapshots describe

On this page

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

Return the details for the specified snapshot for your project.

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

Command Syntax
atlas backups snapshots describe <snapshotId> [options]
Name
Type
Required
Description
snapshotId
string
true
Unique identifier of the snapshot you want to retrieve.
Name
Type
Required
Description
--clusterName
string
true
Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api.
-h, --help
false
help for describe
-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.
--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.

ID SNAPSHOT TYPE TYPE DESCRIPTION EXPIRES AT
<Id> <SnapshotType> <Type> <Description> <ExpiresAt>
# Return the details for the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the cluster named myDemo:
atlas backups snapshots describe 5f4007f327a3bd7b6f4103c5 --clusterName myDemo

Back

delete