Skip to main content
Version: v5.6.1

opschain admin nodes export

Included from Basic tier

opschain admin nodes export <path> [--out <file.zip>] [--with-history]

Captures a node's subtree as one credential-free zip — the lasting record to take before delete and destroy. The archive holds:

  • definitions — the nodes, templates and their versions (as git coordinates), git remotes without their credentials (the excluded fields are recorded), workflows, triggers, and the properties/settings document values;
  • history — the run history as JSONL and the full event trail;
  • manifest.json — format opschain-node-export/1, the source path and kind, per-type counts, and what was excluded: log lines and artifact blobs stay on the server, with the blob digests recorded.

The download is streamed to the output file and then verified by opening the zip and reading its manifest, so a mid-stream server failure surfaces as an incomplete-archive error rather than passing silently.

Flags​

FlagMeaning
--out <file.zip>Write the archive to this file. Default: <code>-export.zip in the current directory (e.g. demo-export.zip).
--with-historyAlso include the properties/settings version trails, not just their current values.

Exit codes​

CodeMeaning
0Exported and verified.
1The export failed, the node was not found, or the archive did not verify.
2Usage error — malformed path, no server target.

Named errors​

  • /projects/… was not found (or you are not permitted to export it)
  • exporting /projects/… failed (<status>): <body>
  • the downloaded archive is not a complete export: … — the zip did not open, has no manifest.json, or declares an unsupported export format "…".
  • expected a node path like demo, demo/environments/dev or /projects/demo/environments/dev/assets/web, got "…" (exit 2)
  • nodes operate on a server's estate — pass --server <url> or 'opschain context use <name>' (exit 2)

Examples​

opschain admin nodes export demo
exported /projects/demo to demo-export.zip
changes 214
events 5102
nodes 7
…
excluded: 48210 log lines, 12 artifact blobs (digests recorded in the manifest)
opschain admin nodes export demo/environments/dev --out dev-backup.zip --with-history

-o json / -o yaml print {"file": …, "manifest": …} instead of the summary lines.

See also​

  • opschain docs cli/admin-nodes-import — recreate the definitions from the archive.
  • opschain docs cli/admin-nodes-delete and opschain docs cli/admin-nodes-destroy — the steps the export precedes.
  • opschain learn 8.1 — backup and interchange, guided.