Docs Using Kumo.io
Using Kumo.io
Exports
Download any diagram as SVG, PNG, PDF or Visio, and any workspace's resources and connections as CSV, JSON or a ZIP of both. Every export shows only what your role can see, and records the snapshot it came from.
What you can export
| What | Formats | Where |
|---|---|---|
| A diagram | SVG, PNG, PDF, Visio (VSDX) | The Export menu on the diagram |
| A workspace's resources and connections | CSV, JSON, or a ZIP of all four files | Export Data on the workspace's Overview tab |
| A filtered resource list | CSV | Export on the Resources page |
| A report | JSON, CSV, Markdown, HTML, PDF | The Reports page. See How do I produce a report? |
| A change comparison | JSON, CSV | The CLI or API. See What changed in my estate? |
| A whole workspace, to import elsewhere | NDJSON or ZIP archive | The CLI or API. See How do I move a workspace's data in or out? |
Which plans include exports
| Plan | Diagram SVG and PNG, workspace data | Diagram PDF and Visio |
|---|---|---|
| During a trial, and read-only after one | Not included | Not included |
| Team, Business, Enterprise | Included | Included |
| Enterprise (Licensed) (self-hosted) | Included | Included |
On a plan without PDF and Visio export, PNG downloads carry a watermark.
The Resources page CSV is built in your browser from the rows on screen, so it's available on every plan.
Export a diagram
On a diagram, open Export ▾. The menu says what you'll get: Exports the latest snapshot as it was generated. Notes and cost overlays are not included. If you're viewing an earlier snapshot, it exports that snapshot instead.
| Option | You get |
|---|---|
| Download SVG | view.svg, the stored vector image, exactly as the page shows it. |
| Download PNG | view.png. Choose Size (1×, 2× or 4×) and Background (Transparent, Dark or White) first. |
| Download PDF | view.pdf, a single vector page. |
| Download VSDX | view.vsdx, a Microsoft Visio drawing. |
The Size and Background options apply to PNG only.
Exports always use the snapshot as it was generated: they never redraw it against newer data, and they never include notes, the cost overlay, a tag filter or an unsaved context change. To export a diagram after changing how it's drawn, save your change first (see How do I read, edit and customise a diagram?).
If your plan doesn't include a format, its buttons stay visible but locked; selecting one opens an upgrade panel.
Export workspace data
Open a workspace, go to its Overview tab and expand Export Data. Each button downloads a snapshot of the workspace's latest revision:
| Button | File |
|---|---|
| Resources CSV | kumo-resources.csv |
| Resources JSON | kumo-resources.json |
| Connections CSV | kumo-connections.csv |
| Connections JSON | kumo-connections.json |
| Download All (.Zip) | kumo-workspace.zip |
What's in each file:
- Resources CSV:
id,semanticTypeanddisplayNamecolumns, then one column per attribute key, sorted. If the workspace has more than 256 distinct attribute keys, the attributes go into a singleattributescolumn as JSON instead. - Connections CSV:
id,connectionType,fromResourceId,toResourceIdandattributes(JSON). - JSON files: a document with
schemaVersion(currently1),kind,exportedAt,workspaceId,workspaceGraphRevisionId,countand the list of resources or connections. Pin your tooling toschemaVersion. - ZIP: all four files plus
manifest.json, which records the workspace, the revision, the export time and the resource and connection counts.
The export holds your real inventory only. Kumo.io's internal grouping nodes and membership links are left out.
Export a resource list
On the Resources page, filter the list, then choose Export:
- Export N Selected downloads the rows you've ticked.
- Export N Loaded Rows downloads every row loaded so far.
The file, kumo-resources.csv, starts with a comment line recording your filters, then the columns name, semanticType, provider, workspace, region, presence, lastObservedAt, resourceId and workspaceId. It contains only rows that have been loaded. For a complete inventory, use Export Data instead.
Export from the CLI (self-hosted)
On a self-hosted installation, run kumo view export on the installation to write diagrams to disk:
kumo view export --format svg --out ./diagrams
kumo view export --format svg --out ./diagrams --workspace <id>
kumo view export --format svg --out ./diagrams --environment <id>
- SVG is the only format the CLI exports. For PNG, PDF or Visio, use the app or the API.
- It writes the latest rendered snapshot of every diagram in scope to
<out>/<workspace>/<environment>/<diagram>.svg, creating the directory if needed. Without--workspaceor--environmentit covers every workspace you can read; you can't combine the two. - Diagrams that haven't been generated yet, or don't render as SVG, are skipped and counted in the summary.
--use-idsnames folders and files by id instead of name.--report jsonprints the summary as JSON.--quiethides the per-file log.- Exporting a single diagram (
--view) isn't supported yet.
kumo view export runs against the installation's own database, so it isn't available against kumo.io. On kumo.io, use the app or the API.
To export a change comparison, run kumo changes comparison export --artifact <id> --export-format json|csv on the installation.
Export through the API
The diagram and workspace data exports are API calls you can script with an API token. Paths below are relative to /v1/accounts/{accountId}/workspaces/{workspaceId}.
| Request | Returns |
|---|---|
GET …/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.png | PNG. Optional width (pixels, keeps the aspect ratio), scale and bg (a background colour; transparent by default). |
GET …/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.pdf | PDF. Optional title and bg (white by default). |
GET …/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.vsdx | Visio drawing. Optional title. |
GET …/export/resources.csv, …/export/resources.json, …/export/connections.csv, …/export/connections.json | The workspace data files above. |
GET …/export/workspace.zip | The ZIP above. |
POST …/export/workspace.zip/jobs | Builds the same ZIP in the background and returns a job. Download it with GET …/export/jobs/{jobId}/download once it's done. |
The workspace data exports read the latest revision. To export an earlier one, add ?asOf.workspaceGraphRevisionId=<revision-id>.
See How do I authenticate to the API?, How do I track a long-running request? and the API reference.
Exports never show more than you can see
An export carries your access with it. It's built from the same read your role is allowed in the app, with the same field redaction, so a CSV can't contain anything your screen couldn't show. There is no format or option that widens it. See What does Kumo.io store about my resources?