Skip to Content

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

FlagDescription
--endpoint <URL>API endpoint.
--token <TOKEN>Bearer token.
--jsonJSON output.

Subcommands

SubcommandPurpose
createCreate a new backup archive.
listList available backups.
restoreRestore from a backup archive.

Examples

Create a dated archive:

hiveloom backup create --output /var/backups/hiveloom-$(date +%F).tar.gz

List existing archives:

hiveloom backup list

Restore (stops the service, replaces the data dir, restarts it):

hiveloom backup restore --input /var/backups/hiveloom-2026-04-25.tar.gz

What’s in the archive

FileWhat it is
platform.dbTenant + agent metadata.
tenants/<slug>.dbPer-tenant agent state, conversations, capabilities.
master.keySymmetric 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