atlas api sharedTierSnapshots downloadSharedClusterBackup

On this page

experimental: Requests one snapshot for the specified shared cluster.

This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'downloadSharedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup

Syntax

Command Syntax

atlas api sharedTierSnapshots downloadSharedClusterBackup [options]

Name	Type	Required	Description
--clusterName	string	true	human-readable label that identifies the cluster
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--file	string	false	path to the file which contains the api request contents
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for downloadSharedClusterBackup
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--pretty		false	flag that indicates whether the response body should be in the prettyprint format
--version	string	false	api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

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.

Back

sharedTierSnapshots

getSharedClusterBackup