CLI

tigby export

Take your data out

A zip: a manifest, the account as JSON, and per Identity the Mailbox as mbox with a JSON manifest beside it. Art. 15 and 20, self-serve. The archive is encrypted at rest under the Org's own key while it waits and is deleted when it expires, so an export is not a second copy of everything that lives forever.

tigby export start

Start an export.

Answers with the run. Poll it with tigby export get, or pass --wait to sit here until it is ready. Vault values are left out unless --include-secret-values says otherwise, and the archive's manifest says which it was either way.

tigby export start [options]
OptionWhat it does
--identity <handle>Export one Identity instead of the whole account. An Identity Key exports its own without this.
--include-secret-valuesPut the Vault's values in the archive in the clear. Org scope only.
--waitStay until the run is ready or failed.
--out <path>Download the archive to this path once it is ready. Implies --wait.
tigby export start
tigby export start --identity shopbot --out shopbot.zip

tigby export list

List export runs.

Newest first, with what each one covers and how long its archive still lives.

tigby export list [options]

tigby export get

One export run.

Its status, and – once it is ready – its size, its SHA-256 and when it expires.

tigby export get <id> [options]
ArgumentWhat it is
<id>The run's id, from start or list.
OptionWhat it does
--waitStay until the run is ready or failed.

tigby export download

Download an archive.

Writes the zip to --out, or to the run's own file name in the working directory. The SHA-256 the API reported is checked against the bytes that arrived.

tigby export download <id> [options]
ArgumentWhat it is
<id>The run's id.
OptionWhat it does
--out <path>Where to write it.
tigby export download 0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b --out account.zip