atlas api flexRestoreJobs createFlexBackupRestoreJob

On this page

experimental: Restores one snapshot of one flex cluster from the specified project.

To use this resource, the requesting API Key must have the Project Owner role.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax

atlas api flexRestoreJobs createFlexBackupRestoreJob [options]

Name	Type	Required	Description
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--file	string	false	path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for createFlexBackupRestoreJob
--name	string	true	human-readable label that identifies the flex cluster whose snapshot you want to restore
--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: "2024-11-13"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-11-13".
-w, --watch		false	Flag that indicates whether to watch the command until it completes its execution or the watch times out.
--watchTimeout	int	false	Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.

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

flexRestoreJobs

getFlexBackupRestoreJob