hiveloom backup
Captures and restores a complete instance archive: platform DB, every tenant DB, and the encryption master key. Run this before every upgrade, and on a schedule for disaster recovery.
Synopsis
hiveloom backup [GLOBAL FLAGS] <COMMAND>Global flags
| Flag | Description |
|---|---|
--endpoint <URL> | API endpoint. |
--token <TOKEN> | Bearer token. |
--json | JSON output. |
Subcommands
| Subcommand | Purpose |
|---|---|
create | Create a new backup archive. |
list | List available backups. |
restore | Restore from a backup archive. |
Examples
Create a dated archive:
hiveloom backup create --output /var/backups/hiveloom-$(date +%F).tar.gzList existing archives:
hiveloom backup listRestore (stops the service, replaces the data dir, restarts it):
hiveloom backup restore --input /var/backups/hiveloom-2026-04-25.tar.gzWhat’s in the archive
| File | What it is |
|---|---|
platform.db | Tenant + agent metadata. |
tenants/<slug>.db | Per-tenant agent state, conversations, capabilities. |
master.key | Symmetric key used to encrypt credentials at rest. |
The master key is in the archive so a restore is self-contained. Treat the archive as a top-tier secret: anyone with it can decrypt every stored credential. Store it in encrypted off-VPS storage.
See also
- Upgrade — backup is step 1.
- Backup & restore — full disaster-recovery walkthrough.