atlas api cloudBackups getShardedClusterBackup

: This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.

Atlas CLI support for running commands with the Atlas Administration API is in Preview. The feature and the corresponding documentation might change at any time during the Preview period. To learn more, see Preview Features.

experimental: Returns one snapshot of one sharded cluster from the specified project.

To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role. This command is invoking the endpoint with OperationID: 'getShardedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup

Syntax

Command Syntax

atlas api cloudBackups getShardedClusterBackup [options]

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
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for getShardedClusterBackup
--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
--snapshotId	string	true	unique 24-hexadecimal digit string that identifies the desired snapshot
--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".

Inherited Options

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

getReplicaSetBackup

listBackupExportJobs