1# Backup Command
2
3Manage backups for database attachments.
4
5## gordon backups
6
7```bash
8gordon backups <subcommand>
9```
10
11Subcommands:
12
13- `list [domain]` - List backups globally or for one domain
14- `run <domain> [--db <name>]` - Trigger an immediate backup
15- `detect <domain>` - Detect supported databases for a domain
16- `status` - Show backup status across domains
17
18> Backup commands work both locally and remotely.
19>
20> - Local mode (no `--remote`) executes backups through in-process services.
21> - Remote mode uses the admin API on the target instance.
22>
23> `gordon backups run <domain>` auto-selects the database only when exactly one supported DB attachment is detected. If multiple DB attachments are present, pass `--db <name>`.
24
25In normal usage, configure remotes once (`gordon remotes ...`) and run backup commands without per-command remote flags.
26
27## Examples
28
29```bash
30# List all backups
31gordon backups list
32
33# List backups for one domain
34gordon backups list app.example.com
35
36# Trigger backup (auto-detect when exactly one DB attachment exists)
37gordon backups run app.example.com
38
39# Trigger backup for specific attachment name
40gordon backups run app.example.com --db postgres
41
42# Detect DB attachments
43gordon backups detect app.example.com
44
45# Status summary
46gordon backups status
47```
48
49## Output Columns
50
51### list
52
53```text
54<domain>\t<db>\t<status>\t<started_at>\t<backup_id>
55```
56
57### detect
58
59```text
60<name>\t<type>\t<host>\t<port>\t<image>
61```
62
63### status
64
65```text
66<domain>\t<db>\t<status>\t<started_at>
67```
68
69### run
70
71```text
72<domain>\t<db>\t<status>\t<started_at>\t<backup_id>\t<size_bytes>
73```
74
75## Required Permissions
76
77- Read operations (`list`, `status`, `detect`) require `admin:status:read`.
78- `run` requires `admin:config:write`.
79
80## Related
81
82- [CLI Commands](./index.md)
83- [Backups Configuration](../config/backups.md)