CLICommand referencebackuppolicy
backup policy
Commands, arguments, and options for synq backup policy.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
synq backup policy
Backup policies (schedules) for a project
synq backup policy [options] [command]| Subcommand | Purpose |
|---|---|
list [options] | List backup policies for a project |
create [options] | Create a backup policy for a project |
run [options] <policyId> | Trigger a policy's backup now |
update <policyId> <file> | Update a backup policy from a JSON file |
remove|rm <policyId> | Remove a backup policy |
synq backup policy create
Create a backup policy for a project
synq backup policy create [options]| Option | Meaning |
|---|---|
--project <id> | Project ID |
--destination <id> | Backup destination ID |
--service <id> | Scope the policy to a single service |
--cron <expr> | Cron schedule (e.g. '0 3 * * *') |
--pre-deploy | Also run this backup before each deploy |
--retain-count <n> | Keep at most N runs |
--retain-days <n> | Keep runs for N days |
--payload-kind <kind> | Payload kind (default: auto) |
--payload-config <json> | Payload config as a JSON object |
--pre-hook <cmd> | Shell command run before the backup |
--post-hook <cmd> | Shell command run after the backup |
--disabled | Create the policy disabled |
synq backup policy list
List backup policies for a project
synq backup policy list [options]| Option | Meaning |
|---|---|
--project <id> | Project ID |
synq backup policy remove
Remove a backup policy
synq backup policy remove|rm [options] <policyId>synq backup policy run
Trigger a policy's backup now
synq backup policy run [options] <policyId>| Argument | Meaning |
|---|---|
policyId | Backup policy ID |
| Option | Meaning |
|---|---|
--follow | Stream the run to completion |
synq backup policy update
Update a backup policy from a JSON file
synq backup policy update [options] <policyId> <file>