Skip to main content
unbound download exports your organization’s data as CSV — the same exports offered in the dashboard, from the terminal. Requires Admin or Analytics Viewer role. Run unbound status to check.

​
What can be exported

unbound download kinds also lists the filters each one accepts. The list comes from your installed CLI, so a kind added to Unbound more recently still works even though it is not listed — upgrade the CLI to see it.

​
Export something

The command starts the export, waits for it, and saves the file. Without -o it writes a file named by the server in the current directory, and refuses to overwrite one that already exists.

​
Time range

Omit both and the server applies its own default window.

​
Filters

--search <text> matches free text, on the logs kinds only. Repeat --filter with the same key to pass a list:
Only a filter key the export recognises is applied, so a typo widens the export rather than narrowing it — tool_type=CURSOR returns every tool. An invalid value for a known key is rejected, with the accepted values listed. Run --check first and confirm the count moved.

​
Check before you export

--check counts the rows without starting anything:
An export of more than 25,000 rows is refused up front, with the real count, so narrow the range or add filters rather than paging.

​
If you stop waiting

A large export takes a few minutes. The job ID is printed when it starts:
Interrupting the wait does not cancel the export. Fetch the finished file within 6 hours:
--no-wait starts an export and returns the ID immediately, for a script that would rather collect it later:
Only 3 exports may be preparing at once per organization. A fourth returns an error asking you to wait — do not poll by re-running the export. An export still queued or running 2 hours after it was started is marked failed. unbound download get then prints The download stopped unexpectedly. Please run it again. and exits 1. A failed job is finished for good — start a new export rather than re-fetching that ID.

​
What the CSV does to your data

Values are normalised so a spreadsheet reads the file correctly, which matters if you diff two exports or script against one:
  • Newlines inside a value become spaces, so each record stays on one row.
  • A value over 32,000 characters is cut and ends … [truncated].
  • Some values carry a leading ', and the file opens with a byte-order mark.
Read the file as utf-8-sig and strip a leading ' from any cell you compare.

​
Output flags

​
For scripts and agents

unbound download start waits for the export and blocks until the file is on disk; --no-wait returns the job ID instead, and unbound download get <id> fetches the file once it is ready. Without -o, the destination depends on where output is going: a file named by the server when you are at a terminal, and stdout when it is piped or redirected. Diagnostics go to stderr either way, so the stream stays clean. The exit code is 0 on success and 1 on any error.
Requires CLI 1.15.0 or later. Tool Use data can also be exported with unbound analytics tool-use <dataset> --format csv, which uses this same flow — see Analytics.