CLICommand referencebackup

backup

Commands, arguments, and options for synq backup.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

synq backup

Manage backups: policies, runs, restores, destinations

synq backup [options] [command]
SubcommandPurpose
policyBackup policies (schedules) for a project
runBackup runs (executions)
restoreManage staged restores
destinationBackup destinations (storage targets)

synq backup restore

Manage staged restores

synq backup restore [options] [command]
SubcommandPurpose
apply [options] <restoreId>Apply a staged restore (destructive)
cancel <restoreId>Cancel a staged or in-flight restore
get [options] <restoreId>Show one restore (optionally stream it)

synq backup restore apply

Apply a staged restore (destructive)

synq backup restore apply [options] <restoreId>
ArgumentMeaning
restoreIdRestore ID from backup run restore
OptionMeaning
--token <token>Confirmation token from prepare
--followStream the restore to completion

synq backup restore cancel

Cancel a staged or in-flight restore

synq backup restore cancel [options] <restoreId>
ArgumentMeaning
restoreIdRestore ID

synq backup restore get

Show one restore (optionally stream it)

synq backup restore get [options] <restoreId>
ArgumentMeaning
restoreIdRestore ID
OptionMeaning
--followStream progress to completion

On this page