Dataroom
The hanzo dataroom commands.
Also for this capability: API · CLI · MCP · SDKs
A secure document room you share by link and watch page by page.
hanzo dataroom datarooms listEvery command takes --json for the raw response and --help for its own flags. Sign in once with hanzo auth login; the commands below use that session, and the org they act in is the one it carries.
| Command | What it does |
|---|---|
hanzo dataroom health | Reports that the data room subsystem is up. |
Analytics
| Command | What it does |
|---|---|
hanzo dataroom analytics dataroom get <dataroomId> | Rolls up every share link pointing at one data room: session and page-view totals for the room, plus the per-page breakdown for each link beneath it. |
hanzo dataroom analytics link get <linkId> | Reports how one share link was actually read: total viewing sessions, total page views, and per page the view count, the summed dwell measure and its average. |
Datarooms
| Command | What it does |
|---|---|
hanzo dataroom datarooms create | Opens a new data room for the caller org and answers with it, including the short public id it is addressed by. |
hanzo dataroom datarooms documents <id> | Puts an already-uploaded document into one of the caller org's data rooms and answers with the new membership id. |
hanzo dataroom datarooms get <id> | Reads one of the caller org's data rooms together with every document in it, each carrying its membership id and order index. |
hanzo dataroom datarooms list | Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps. |
Documents
| Command | What it does |
|---|---|
hanzo dataroom documents create | Upload a document's bytes and record it |
hanzo dataroom documents file <id> | Download a document's bytes as its owner |
hanzo dataroom documents get <id> | Reads one of the caller org's documents — its name, opaque storage key, content type, page count, size and timestamps. |
hanzo dataroom documents list | Returns every document in the caller org's own store, newest first — name, opaque storage key, content type, page count, size and timestamps. |
Links
| Command | What it does |
|---|---|
hanzo dataroom links create | Grants access: it mints a public share link over one data room (dataroomId) or one document (documentId) — one of the two is required — and answers with the link, whose id is the token a visitor opens it with. |
hanzo dataroom links get | Returns every live share link in the caller org's own store, newest first, with the controls a visitor will meet: whether an address is required, whether a password is set, the allow and deny lists, whether download is permitted, and when the link expires. |
Trust
| Command | What it does |
|---|---|
hanzo dataroom trust artifacts create | Puts an item on the caller org's trust centre and answers with it. |
hanzo dataroom trust artifacts update <id> | Changes an item on the caller org's trust centre — replace its file with a newer edition, move it between public and gated, rewrite what it says, or retire it — and answers with the item as it now stands. |
hanzo dataroom trust center file get <slug> <item> | Read a public trust-centre item's bytes |
hanzo dataroom trust center get <slug> | Answers an org's public trust centre: its name, the text a party must accept to ask for a document, and every item it publishes. |
hanzo dataroom trust center requests <slug> | Records a request to read what an independent auditor signed, and answers with its id. |
hanzo dataroom trust get | Answers the caller org's OWN trust centre: its settings, every item it holds in both tiers, the requests waiting on it, and the grants it has made. |
hanzo dataroom trust replace | Opens, publishes or withdraws the caller org's trust centre and answers with the centre as it now stands. |
hanzo dataroom trust requests grant <id> | Answers a request by opening access: it mints a share link over what was asked for, addressed to the address that asked and closing at expiry, records the decision, and mails the asker. |
hanzo dataroom trust requests refuse <id> | Answers a request by declining it, recording who declined and why. |
View
| Command | What it does |
|---|---|
hanzo dataroom view authenticate <linkId> | Pass a share link's gates and open a viewing session |
hanzo dataroom view document file <linkId> <documentId> | Read a document's bytes as an authorised link visitor |
hanzo dataroom view get <linkId> | What a share link's visitor sees before authenticating |
hanzo dataroom view pageview <linkId> | Record one page-view against an open viewing session |
Was this page useful?