watermint toolbox, user manual

watermint toolbox, user manual. This document describes the commands and options available in the watermint toolbox.

Title: Common Options for All Commands URL: https://toolbox.watermint.org/commands/common-options.md —

Common command options

Option	Description	Default
`-auth-database`	Custom path to auth database (default: $HOME/.toolbox/secrets/secrets.db)
`-auto-open`	Auto open URL or artifact folder	false
`-bandwidth-kb`	Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited	0
`-budget-memory`	Memory budget (limits some feature to reduce memory footprint)	normal
`-budget-storage`	Storage budget (limits logs or some feature to reduce storage usage)	normal
`-concurrency`	Maximum concurrency for running operation	Number of processors
`-debug`	Enable debug mode	false
`-experiment`	Enable experimental feature(s).
`-extra`	Extra parameter file path
`-lang`	Display language	auto
`-output`	Output format (none/text/markdown/json)	text
`-output-filter`	Output filter query (jq syntax). The output of the report is filtered using jq syntax. This option is only applied when the report is output as JSON.
`-proxy`	HTTP/HTTPS proxy (hostname:port). Please specify `DIRECT` if you want skip setting proxy.
`-quiet`	Suppress non-error messages, and make output readable by a machine (JSON format)	false
`-retain-job-data`	Job data retain policy	default
`-secure`	Do not store tokens into a file	false
`-skip-logging`	Skip logging in the local storage	false
`-verbose`	Show current operations for more detail.	false
`-workspace`	Workspace path

Commands

Title: license URL: https://toolbox.watermint.org/commands/license.md —

license

Show license information

Usage

This document uses the Desktop folder for command example.

tbx license

Title: version URL: https://toolbox.watermint.org/commands/version.md —

version

Show version

Usage

This document uses the Desktop folder for command example.

tbx version

Results

Report: versions

Components and version information. The command will generate a report in three different formats. versions.csv, versions.json, and versions.xlsx.

Column	Description
key	Key
component	Component
version	Version

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; versions_0000.xlsx, versions_0001.xlsx, versions_0002.xlsx, …

Title: config auth delete URL: https://toolbox.watermint.org/commands/config/auth/delete.md —

config auth delete

Delete existing auth credential

Usage

This document uses the Desktop folder for command example.

tbx config auth delete -key-name KEY_NAME -peer-name PEER_NAME

Options:

Option	Description	Default
`-key-name`	Application key name
`-peer-name`	Peer name

Results

Report: deleted

Auth credential data The command will generate a report in three different formats. deleted.csv, deleted.json, and deleted.xlsx.

Column	Description
key_name	Application name
scope	Auth scope
peer_name	Peer name
description	Description
timestamp	Timestamp

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; deleted_0000.xlsx, deleted_0001.xlsx, deleted_0002.xlsx, …

Title: config auth list URL: https://toolbox.watermint.org/commands/config/auth/list.md —

config auth list

List all auth credentials

Usage

This document uses the Desktop folder for command example.

tbx config auth list

Results

Report: entity

Auth credential data The command will generate a report in three different formats. entity.csv, entity.json, and entity.xlsx.

Column	Description
key_name	Application name
scope	Auth scope
peer_name	Peer name
description	Description
timestamp	Timestamp

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; entity_0000.xlsx, entity_0001.xlsx, entity_0002.xlsx, …

Title: config feature disable URL: https://toolbox.watermint.org/commands/config/feature/disable.md —

config feature disable

Disable a feature.

Usage

This document uses the Desktop folder for command example.

tbx config feature disable -key FEATURE

Options:

Option	Description	Default
`-key`	Feature key.

Title: config feature enable URL: https://toolbox.watermint.org/commands/config/feature/enable.md —

config feature enable

Enable a feature.

Usage

This document uses the Desktop folder for command example.

tbx config feature enable -key FEATURE

Options:

Option	Description	Default
`-key`	Feature key.

Title: config feature list URL: https://toolbox.watermint.org/commands/config/feature/list.md —

config feature list

List available optional features.

Usage

This document uses the Desktop folder for command example.

tbx config feature list

Title: config license install URL: https://toolbox.watermint.org/commands/config/license/install.md —

config license install

Install a license key

Usage

This document uses the Desktop folder for command example.

tbx config license install -key LICENSE_KEY

Options:

Option	Description	Default
`-key`	License key

Title: config license list URL: https://toolbox.watermint.org/commands/config/license/list.md —

config license list

List available license keys

Usage

This document uses the Desktop folder for command example.

tbx config license list

Results

Report: keys

License key summary The command will generate a report in three different formats. keys.csv, keys.json, and keys.xlsx.

Column	Description
key	License key
expiration_date	Expiration date
valid	True if the license key is valid
licensee_name	Licensee name
licensee_email	Licensee email
licensed_recipes	Recipes enabled by this licence key

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; keys_0000.xlsx, keys_0001.xlsx, keys_0002.xlsx, …

Title: log api job URL: https://toolbox.watermint.org/commands/log/api/job.md —

log api job

Show statistics of the API log of the job specified by the job ID

Usage

This document uses the Desktop folder for command example.

tbx log api job

Options:

Option	Description	Default
`-full-url`	Show full URL	false
`-interval-second`	Interval in seconds for the time series	3600
`-job-id`	Job ID

Results

Report: latencies

Latency The command will generate a report in three different formats. latencies.csv, latencies.json, and latencies.xlsx.

Column	Description
url	URL
code	Response code
population	Number of requests
mean	Mean
median	Median
p_50	Percentile 50
p_70	Percentile 70
p_90	Percentile 90

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; latencies_0000.xlsx, latencies_0001.xlsx, latencies_0002.xlsx, …

Report: population

Number of requests The command will generate a report in three different formats. population.csv, population.json, and population.xlsx.

Column	Description
url	URL
code	Response code
population	Number of requests
proportion	Proportion

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; population_0000.xlsx, population_0001.xlsx, population_0002.xlsx, …

Report: time_series

Time series summary The command will generate a report in three different formats. time_series.csv, time_series.json, and time_series.xlsx.

Column	Description
time	Time
url	URL
code_2xx	Number of requests with 2xx
code_3xx	Number of requests with 3xx
code_4xx	Number of requests with 4xx (except 429)
code_429	Number of requests with 429
code_5xx	Number of requests with 5xx
code_other	Number of requests with other

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; time_series_0000.xlsx, time_series_0001.xlsx, time_series_0002.xlsx, …

Title: log api name URL: https://toolbox.watermint.org/commands/log/api/name.md —

log api name

Show statistics of the API log of the job specified by the job name

Usage

This document uses the Desktop folder for command example.

tbx log api name -name JOB_NAME

Options:

Option	Description	Default
`-full-url`	Show full URL	false
`-interval-second`	Interval in seconds for the time series	3600
`-name`	Job command line path (e.g. `dropbox team member list`)

Results

Report: latencies

Latency The command will generate a report in three different formats. latencies.csv, latencies.json, and latencies.xlsx.

Column	Description
url	URL
code	Response code
population	Number of requests
mean	Mean
median	Median
p_50	Percentile 50
p_70	Percentile 70
p_90	Percentile 90

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; latencies_0000.xlsx, latencies_0001.xlsx, latencies_0002.xlsx, …

Report: population

Number of requests The command will generate a report in three different formats. population.csv, population.json, and population.xlsx.

Column	Description
url	URL
code	Response code
population	Number of requests
proportion	Proportion

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; population_0000.xlsx, population_0001.xlsx, population_0002.xlsx, …

Report: time_series

Time series summary The command will generate a report in three different formats. time_series.csv, time_series.json, and time_series.xlsx.

Column	Description
time	Time
url	URL
code_2xx	Number of requests with 2xx
code_3xx	Number of requests with 3xx
code_4xx	Number of requests with 4xx (except 429)
code_429	Number of requests with 429
code_5xx	Number of requests with 5xx
code_other	Number of requests with other

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; time_series_0000.xlsx, time_series_0001.xlsx, time_series_0002.xlsx, …

Title: log cat curl URL: https://toolbox.watermint.org/commands/log/cat/curl.md —

log cat curl

Format capture logs as curl sample

Usage

This document uses the Desktop folder for command example.

tbx log cat curl

Options:

Option	Description	Default
`-buffer-size`	Buffer size for each request	65536
`-record`	Give a record of capture log file via command line option

Title: log cat job URL: https://toolbox.watermint.org/commands/log/cat/job.md —

log cat job

Retrieve logs of specified Job ID

Usage

This document uses the Desktop folder for command example.

tbx log cat job -id JOB_ID

Options:

Option	Description	Default
`-id`	Job ID
`-kind`	Kind of log	toolbox
`-path`	Path to the workspace

Title: log cat kind URL: https://toolbox.watermint.org/commands/log/cat/kind.md —

log cat kind

Concatenate and print logs of specified log kind

Usage

This document uses the Desktop folder for command example.

tbx log cat kind

Options:

Option	Description	Default
`-kind`	Log kind.	toolbox
`-path`	Path to workspace.

Title: log cat last URL: https://toolbox.watermint.org/commands/log/cat/last.md —

log cat last

Print the last job log files

Usage

This document uses the Desktop folder for command example.

tbx log cat last

Options:

Option	Description	Default
`-kind`	Log kind	toolbox
`-path`	Path to workspace.

Title: log job archive URL: https://toolbox.watermint.org/commands/log/job/archive.md —

log job archive

Archive jobs

Usage

This document uses the Desktop folder for command example.

tbx log job archive

Options:

Option	Description	Default
`-days`	Target days old	7
`-path`	Path to the workspace

Title: log job delete URL: https://toolbox.watermint.org/commands/log/job/delete.md —

log job delete

Delete old job history

Usage

This document uses the Desktop folder for command example.

tbx log job delete

Options:

Option	Description	Default
`-days`	Target days old	28
`-path`	Path to the workspace

Title: log job list URL: https://toolbox.watermint.org/commands/log/job/list.md —

log job list

Show job history

Usage

This document uses the Desktop folder for command example.

tbx log job list

Options:

Option	Description	Default
`-path`	Path to workspace

Results

Report: log

This report shows a list of job histories. The command will generate a report in three different formats. log.csv, log.json, and log.xlsx.

Column	Description
job_id	Job ID
app_version	App version
recipe_name	Command
time_start	Time Started
time_finish	Time Finished

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; log_0000.xlsx, log_0001.xlsx, log_0002.xlsx, …

Title: util archive unzip URL: https://toolbox.watermint.org/commands/util/archive/unzip.md —

util archive unzip

Extract the zip archive file

Usage

This document uses the Desktop folder for command example.

tbx util archive unzip -in /LOCAL/PATH/TO/ARCHIVE.zip -out /LOCAL/PATH/TO/EXTRACT

Options:

Option	Description	Default
`-in`	Zip archive file path
`-out`	Path to extract files

Title: util archive zip URL: https://toolbox.watermint.org/commands/util/archive/zip.md —

util archive zip

Compress target files into the zip archive

Usage

This document uses the Desktop folder for command example.

tbx util archive zip -out /LOCAL/PATH/TO/ARCHIVE.zip -target /LOCAL/PATH/TO/COMPRESS

Options:

Option	Description	Default
`-comment`	Comment for the zip archive
`-out`	Zip archive file path
`-target`	Target path to compress

Title: util cert selfsigned URL: https://toolbox.watermint.org/commands/util/cert/selfsigned.md —

util cert selfsigned

Generate self-signed certificate and key

Usage

This document uses the Desktop folder for command example.

tbx util cert selfsigned -out /LOCAL/PATH/TO/GENERATE_CERT_AND_KEY

Options:

Option	Description	Default
`-days`	Number of validity days of the certificate	365
`-out`	Output folder path

Title: util database exec URL: https://toolbox.watermint.org/commands/util/database/exec.md —

util database exec

Execute query on SQLite3 database file

Usage

This document uses the Desktop folder for command example.

tbx util database exec -file /LOCAL/PATH/DATA.sql -sql SQL

Options:

Option	Description	Default
`-file`	Path to data file
`-sql`	Query

Title: util database query URL: https://toolbox.watermint.org/commands/util/database/query.md —

util database query

Query SQLite3 database

Usage

This document uses the Desktop folder for command example.

tbx util database query -file /LOCAL/PATH/DATA.sql -sql SQL

Options:

Option	Description	Default
`-file`	Path to data file
`-result`	Query result
`-result-format`	Output format
`-sql`	Query

Grid data output of the command

Grid data output: Result

Query result

Title: util date today URL: https://toolbox.watermint.org/commands/util/date/today.md —

util date today

Display current date

Usage

This document uses the Desktop folder for command example.

tbx util date today

Options:

Option	Description	Default
`-offset`	Offset (day)	0
`-utc`	Use UTC	false

Title: util datetime now URL: https://toolbox.watermint.org/commands/util/datetime/now.md —

util datetime now

Display current date/time

Usage

This document uses the Desktop folder for command example.

tbx util datetime now

Options:

Option	Description	Default
`-offset-day`	Offset (day)	0
`-offset-hour`	Offset (hour)	0
`-offset-min`	Offset (min)	0
`-offset-sec`	Offset (sec)	0
`-utc`	Use UTC	false

Title: util decode base32 URL: https://toolbox.watermint.org/commands/util/decode/base32.md —

util decode base32

Decode text from Base32 (RFC 4648) format

Usage

This document uses the Desktop folder for command example.

tbx util decode base32 -text /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-no-padding`	No padding	false
`-text`	Text

Text inputs

Text input: Text

Text to decode

Title: util decode base64 URL: https://toolbox.watermint.org/commands/util/decode/base64.md —

util decode base64

Decode text from Base64 (RFC 4648) format

Usage

This document uses the Desktop folder for command example.

tbx util decode base64 -text /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-no-padding`	No padding	false
`-text`	Text

Text inputs

Text input: Text

Text to decode

Title: util desktop open URL: https://toolbox.watermint.org/commands/util/desktop/open.md —

util desktop open

Open a file or folder with the default application

Usage

This document uses the Desktop folder for command example.

tbx util desktop open -path /LOCAL/PATH/TO/open

Options:

Option	Description	Default
`-path`	Path to the file or folder to open

Title: util encode base32 URL: https://toolbox.watermint.org/commands/util/encode/base32.md —

util encode base32

Encode text into Base32 (RFC 4648) format

Usage

This document uses the Desktop folder for command example.

tbx util encode base32 -text /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-no-padding`	No padding	false
`-text`	Text

Text inputs

Text input: Text

Text to encode

Title: util encode base64 URL: https://toolbox.watermint.org/commands/util/encode/base64.md —

util encode base64

Encode text into Base64 (RFC 4648) format

Usage

This document uses the Desktop folder for command example.

tbx util encode base64 -text /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-no-padding`	No padding	false
`-text`	Text

Text inputs

Text input: Text

Text to decode

Title: util feed json URL: https://toolbox.watermint.org/commands/util/feed/json.md —

util feed json

Load feed from the URL and output the content as JSON

Usage

This document uses the Desktop folder for command example.

tbx util feed json -url URL

Options:

Option	Description	Default
`-compact`	Compact output	false
`-url`	URL of the feed

Title: util file hash URL: https://toolbox.watermint.org/commands/util/file/hash.md —

util file hash

File Hash

Usage

This document uses the Desktop folder for command example.

tbx util file hash -file /LOCAL/PATH/TO/DIGEST

Options:

Option	Description	Default
`-algorithm`	Hash algorithm (md5/sha1/sha256)	sha1
`-file`	Path to the file to create digest

Title: util git clone URL: https://toolbox.watermint.org/commands/util/git/clone.md —

util git clone

Clone git repository

Usage

This document uses the Desktop folder for command example.

tbx util git clone -local-path /LOCAL/PATH/TO/CLONE -url https://github.com/username/repository.git

Options:

Option	Description	Default
`-local-path`	Local path to clone repository
`-reference`	Reference name
`-remote-name`	Name of the remote	origin
`-url`	Git repository url

Title: util image exif URL: https://toolbox.watermint.org/commands/util/image/exif.md —

util image exif

Print EXIF metadata of image file

Usage

This document uses the Desktop folder for command example.

tbx util image exif -file /LOCAL/PATH/TO/IMG.jpg

Options:

Option	Description	Default
`-file`	Path to data file

Results

Report: metadata

EXIF data The command will generate a report in three different formats. metadata.csv, metadata.json, and metadata.xlsx.

Column	Description
date_time_original	The date and time when the original image data was generated
date_time	The date and time of image creation. In Exif standard, it is the date and time the file was changed.
make	The name of the manufacturer
model	The model name or model number

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; metadata_0000.xlsx, metadata_0001.xlsx, metadata_0002.xlsx, …

Title: util image placeholder URL: https://toolbox.watermint.org/commands/util/image/placeholder.md —

util image placeholder

Create placeholder image

Usage

This document uses the Desktop folder for command example.

tbx util image placeholder -path /LOCAL/PATH/TO/save.png

Options:

Option	Description	Default
`-color`	Background color	white
`-font-path`	Path to True Type font (required if you need to draw a text)
`-font-size`	Font size	12
`-height`	Height (pixel)	400
`-path`	Path to export generated image
`-text`	Text if you need
`-text-align`	Text alignment	left
`-text-color`	Text color	black
`-text-position`	Text position	center
`-width`	Width (pixel)	640

Title: util json query URL: https://toolbox.watermint.org/commands/util/json/query.md —

util json query

Query JSON data

Please refer to jq Manual for the syntax (some features are not supported).

Usage

This document uses the Desktop folder for command example.

tbx util json query -path /LOCAL/PATH/TO/DATA.json -query QUERY

Options:

Option	Description	Default
`-compact`	Compact output	false
`-path`	File path
`-query`	Query string.

Text inputs

Text input: Path

The path to the JSON file

Title: util net download URL: https://toolbox.watermint.org/commands/util/net/download.md —

util net download

Download a file

Usage

This document uses the Desktop folder for command example.

tbx util net download -out /LOCAL/PATH/TO/STORE -url URL_TO_DOWNLOAD

Options:

Option	Description	Default
`-out`	Local path to store
`-url`	URL to download

Title: util qrcode create URL: https://toolbox.watermint.org/commands/util/qrcode/create.md —

util qrcode create

Create a QR code image file

Usage

This document uses the Desktop folder for command example.

tbx util qrcode create -out /LOCAL/PATH/TO/OUT.png -text /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-error-correction-level`	Error correction level (l/m/q/h).	m
`-mode`	QR code encoding mode	auto
`-out`	Output path with file name
`-size`	Image resolution (pixel)	256
`-text`	Text data

Text inputs

Text input: Text

Text

Title: util qrcode wifi URL: https://toolbox.watermint.org/commands/util/qrcode/wifi.md —

util qrcode wifi

Generate QR code for WIFI configuration

Usage

This document uses the Desktop folder for command example.

tbx util qrcode wifi -out /LOCAL/PATH/TO/OUT.png -ssid SSID

Options:

Option	Description	Default
`-error-correction-level`	Error correction level (l/m/q/h).	m
`-hidden`	`true` if a SSID is hidden. `false` if a SSID is visible.
`-mode`	QR code encoding mode	auto
`-network-type`	Network type.	WPA
`-out`	Output path with file name
`-size`	Image resolution (pixel)	256
`-ssid`	Network SSID

Title: util release install URL: https://toolbox.watermint.org/commands/util/release/install.md —

util release install

Download & install watermint toolbox to the path

Usage

This document uses the Desktop folder for command example.

tbx util release install -path /LOCAL/PATH/TO/INSTALL

Options:

Option	Description	Default
`-accept-license-agreement`	Accept to the target release’s license agreement	false
`-path`	Path to install
`-peer`	Account alias	default
`-release`	Release tag name	latest

Title: util table format xlsx URL: https://toolbox.watermint.org/commands/util/table/format/xlsx.md —

util table format xlsx

Formatting xlsx file into text

Usage

This document uses the Desktop folder for command example.

tbx util table format xlsx -sheet SHEET_NAME -dest /LOCAL/PATH/TO/out.txt -template /LOCAL/PATH/TO/template.txt -source /LOCAL/PATH/TO/source.xlsx

Options:

Option	Description	Default
`-dest`	Destination file path
`-position`	Start position of table	A1
`-sheet`	Sheet name
`-source`	Data source xlsx file
`-template`	Template file

Title: util text case down URL: https://toolbox.watermint.org/commands/util/text/case/down.md —

util text case down

Print lower case text

Usage

This document uses the Desktop folder for command example.

tbx util text case down -text /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-text`	Text

Text inputs

Text input: Text

Text to change case

Title: util text case up URL: https://toolbox.watermint.org/commands/util/text/case/up.md —

util text case up

Print upper case text

Usage

This document uses the Desktop folder for command example.

tbx util text case up -text /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-text`	Text

Text inputs

Text input: Text

Text to change case

Title: util text encoding from URL: https://toolbox.watermint.org/commands/util/text/encoding/from.md —

util text encoding from

Convert text encoding to UTF-8 text file from specified encoding.

Usage

This document uses the Desktop folder for command example.

tbx util text encoding from -in /LOCAL/PATH/TO/INPUT_FILE -out /LOCAL/PATH/TO/OUTPUT_FILE -encoding ENCODING

Options:

Option	Description	Default
`-encoding`	Encoding name
`-in`	Input file path
`-out`	Output file path

Text inputs

Text input: In

Text to change encoding

Title: util text encoding to URL: https://toolbox.watermint.org/commands/util/text/encoding/to.md —

util text encoding to

Convert text encoding to specified encoding from UTF-8 text file.

Usage

This document uses the Desktop folder for command example.

tbx util text encoding to -in /LOCAL/PATH/TO/INPUT_FILE -out /LOCAL/PATH/TO/OUTPUT_FILE -encoding ENCODING

Options:

Option	Description	Default
`-encoding`	Encoding name
`-in`	Input file path
`-out`	Output file path

Text inputs

Text input: In

Text to change encoding

Title: util text nlp english entity URL: https://toolbox.watermint.org/commands/util/text/nlp/english/entity.md —

util text nlp english entity

Split English text into entities

Usage

This document uses the Desktop folder for command example.

tbx util text nlp english entity -in /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-ignore-line-break`	Consider line break as regular white space while tokenizing	false
`-in`	Input file path

Text inputs

Text input: In

English text file to split

Title: util text nlp english sentence URL: https://toolbox.watermint.org/commands/util/text/nlp/english/sentence.md —

util text nlp english sentence

Split English text into sentences

Usage

This document uses the Desktop folder for command example.

tbx util text nlp english sentence -in /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-ignore-line-break`	Consider line break as regular white space while tokenizing	false
`-in`	Input file path

Text inputs

Text input: In

English text file to split

Title: util text nlp english token URL: https://toolbox.watermint.org/commands/util/text/nlp/english/token.md —

util text nlp english token

Split English text into tokens

Usage

This document uses the Desktop folder for command example.

tbx util text nlp english token -in /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-ignore-line-break`	Consider line break as regular white space while tokenizing	false
`-in`	Input file path

Text inputs

Text input: In

English text file to split

Title: util text nlp japanese token URL: https://toolbox.watermint.org/commands/util/text/nlp/japanese/token.md —

util text nlp japanese token

Tokenize Japanese text

Usage

This document uses the Desktop folder for command example.

tbx util text nlp japanese token -in /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-dictionary`	Dictionary name of the token	ipa
`-ignore-line-break`	Ignore line break	false
`-in`	Input file path
`-mode`	Tokenize mode (normal/search/extended)	normal
`-omit-bos-eos`	Omit BOS/EOS tokens	false

Text inputs

Text input: In

Input file path

Title: util text nlp japanese wakati URL: https://toolbox.watermint.org/commands/util/text/nlp/japanese/wakati.md —

util text nlp japanese wakati

Wakati gaki (tokenize Japanese text)

Usage

This document uses the Desktop folder for command example.

tbx util text nlp japanese wakati -in /LOCAL/PATH/TO/INPUT.txt

Options:

Option	Description	Default
`-dictionary`	Dictionary name (ipa/uni)	ipa
`-ignore-line-break`	Ignore line break	false
`-in`	Input file path
`-separator`	Text separator

Text inputs

Text input: In

Input text file path

Title: util tidy move dispatch URL: https://toolbox.watermint.org/commands/util/tidy/move/dispatch.md —

util tidy move dispatch

Dispatch files (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx util tidy move dispatch -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-preview`	Preview mode	false

File formats

Format: File

Data file for dispatch rules.

Column	Description	Example
suffix	Source file name suffix	.pdf
source_path	Source path	/Downloads
source_file_pattern	Source file name pattern (regular expression)	toolbox-([0-9]{4})-([0-9]{2})-([0-9]{2})
dest_path_pattern	Destination path pattern	/Document/-
dest_file_pattern	Destination file name pattern	TBX_--

The first line is a header line. The program will accept a file without the header.

suffix,source_path,source_file_pattern,dest_path_pattern,dest_file_pattern
.pdf,<no value>/Downloads,toolbox-([0-9]{4})-([0-9]{2})-([0-9]{2}),<no value>/Document/<no value>-<no value>,TBX_<no value>-<no value>-<no value>

Title: util tidy move simple URL: https://toolbox.watermint.org/commands/util/tidy/move/simple.md —

util tidy move simple

Archive local files

Usage

This document uses the Desktop folder for command example.

tbx util tidy move simple -dst /LOCAL/DEST -src /LOCAL/SRC

Options:

Option	Description	Default
`-dst`	The destination folder path. The command will create folders if not exist on the path.
`-exclude-folders`	Exclude folders	false
`-include-system-files`	Include system files	false
`-preview`	Preview mode	false
`-src`	The source folder path.

Title: util tidy pack remote URL: https://toolbox.watermint.org/commands/util/tidy/pack/remote.md —

util tidy pack remote

Package remote folder into the zip file

Usage

This document uses the Desktop folder for command example.

tbx util tidy pack remote -dropbox-path /DROPBOX/PATH/TO/DOWNLOAD -local-path /LOCAL/PATH/TO/STORE.zip

Options:

Option	Description	Default
`-dropbox-path`	Dropbox path to download
`-local-path`	Local path to store zip file
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.name	The last component of the path (including extension).
input.path_display	The cased path to be used for display purposes only.
input.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
input.size	The file size in bytes.
input.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
result.path	Path
result.name	File name

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: util time now URL: https://toolbox.watermint.org/commands/util/time/now.md —

util time now

Display current time

Usage

This document uses the Desktop folder for command example.

tbx util time now

Options:

Option	Description	Default
`-utc`	Use UTC	false

Title: util unixtime format URL: https://toolbox.watermint.org/commands/util/unixtime/format.md —

util unixtime format

Time format to convert the unix time (epoch seconds from 1970-01-01)

Usage

This document uses the Desktop folder for command example.

tbx util unixtime format

Options:

Option	Description	Default
`-format`	Time format	iso8601
`-precision`	Time precision (second/ms/ns)	second
`-time`	Unix Time	0

Title: util unixtime now URL: https://toolbox.watermint.org/commands/util/unixtime/now.md —

util unixtime now

Display current time in unixtime

Usage

This document uses the Desktop folder for command example.

tbx util unixtime now

Options:

Option	Description	Default
`-precision`	Time precision (second/ms/ns)	second

Title: util uuid timestamp URL: https://toolbox.watermint.org/commands/util/uuid/timestamp.md —

util uuid timestamp

UUID Timestamp

Usage

This document uses the Desktop folder for command example.

tbx util uuid timestamp -uuid UUID

Options:

Option	Description	Default
`-uuid`	UUID

Title: util uuid ulid URL: https://toolbox.watermint.org/commands/util/uuid/ulid.md —

util uuid ulid

ULID Utility

Usage

This document uses the Desktop folder for command example.

tbx util uuid ulid

Title: util uuid v4 URL: https://toolbox.watermint.org/commands/util/uuid/v4.md —

util uuid v4

Generate UUID v4 (random UUID)

Usage

This document uses the Desktop folder for command example.

tbx util uuid v4

Options:

Option	Description	Default
`-upper-case`	Output UUID in upper case	false

Title: util uuid v7 URL: https://toolbox.watermint.org/commands/util/uuid/v7.md —

util uuid v7

Generate UUID v7

Usage

This document uses the Desktop folder for command example.

tbx util uuid v7

Options:

Option	Description	Default
`-upper-case`	Upper case	false

Title: util uuid version URL: https://toolbox.watermint.org/commands/util/uuid/version.md —

util uuid version

Parse version and variant of UUID

Usage

This document uses the Desktop folder for command example.

tbx util uuid version -uuid UUID

Options:

Option	Description	Default
`-uuid`	UUID

Results

Report: metadata

UUID Metadata The command will generate a report in three different formats. metadata.csv, metadata.json, and metadata.xlsx.

Column	Description
uuid	UUID string
version	UUID version
variant	UUID variant

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; metadata_0000.xlsx, metadata_0001.xlsx, metadata_0002.xlsx, …

Title: util xlsx create URL: https://toolbox.watermint.org/commands/util/xlsx/create.md —

util xlsx create

Create an empty spreadsheet

Usage

This document uses the Desktop folder for command example.

tbx util xlsx create -file /LOCAL/PATH/TO/CREATE.xlsx -sheet SHEET_NAME

Options:

Option	Description	Default
`-file`	Path to data file
`-sheet`	Sheet name

Title: util xlsx sheet export URL: https://toolbox.watermint.org/commands/util/xlsx/sheet/export.md —

util xlsx sheet export

Export data from the xlsx file

Usage

This document uses the Desktop folder for command example.

tbx util xlsx sheet export -file /LOCAL/PATH/TO/EXPORT.xlsx -sheet SHEET_NAME

Options:

Option	Description	Default
`-data`	Export data path
`-data-format`	Output format
`-file`	Path to data file
`-sheet`	Sheet name

Grid data output of the command

Grid data output: Data

Export data

Title: util xlsx sheet import URL: https://toolbox.watermint.org/commands/util/xlsx/sheet/import.md —

util xlsx sheet import

Import data into xlsx file

Usage

This document uses the Desktop folder for command example.

tbx util xlsx sheet import -data /LOCAL/PATH/TO/INPUT.csv -file /LOCAL/PATH/TO/TARGET.xlsx -sheet SHEET_NAME

Options:

Option	Description	Default
`-create`	Create a file if not found	false
`-data`	Data path
`-file`	Path to data file
`-position`	Start position to import in A1 notation. Default `A1`.	A1
`-sheet`	Sheet name

Grid data input for the command

Grid data input: Data

Input data file

Title: util xlsx sheet list URL: https://toolbox.watermint.org/commands/util/xlsx/sheet/list.md —

util xlsx sheet list

List sheets of the xlsx file

Usage

This document uses the Desktop folder for command example.

tbx util xlsx sheet list -file /LOCAL/PATH/TO/process.xlsx

Options:

Option	Description	Default
`-file`	Path to data file

Results

Report: sheets

Sheet The command will generate a report in three different formats. sheets.csv, sheets.json, and sheets.xlsx.

Column	Description
name	Name of the sheet
rows	Number of rows
cols	Number of columns
hidden	True when if the sheet marked as hidden

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; sheets_0000.xlsx, sheets_0001.xlsx, sheets_0002.xlsx, …

Title: deepl translate text URL: https://toolbox.watermint.org/commands/deepl/translate/text.md —

deepl translate text

Translate text

Usage

This document uses the Desktop folder for command example.

tbx deepl translate text -target-lang TARGET_LANG -text TEXT_TO_TRANSLATE

Options:

Option	Description	Default
`-peer`	Account alias	default
`-source-lang`	Source language code (auto detect when omitted)
`-target-lang`	Target language code
`-text`	Text to translate

Title: dropbox file copy URL: https://toolbox.watermint.org/commands/dropbox/file/copy.md —

dropbox file copy

Copy files

Usage

This document uses the Desktop folder for command example.

tbx dropbox file copy -src /SRC/PATH -dst /DST/PATH

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dst`	Destination path
`-peer`	Account alias	default
`-src`	Source path

Title: dropbox file delete URL: https://toolbox.watermint.org/commands/dropbox/file/delete.md —

dropbox file delete

Delete file or folder (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file delete -path /PATH/TO/DELETE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path to delete
`-peer`	Account alias	default

Title: dropbox file info URL: https://toolbox.watermint.org/commands/dropbox/file/info.md —

dropbox file info

Resolve metadata of the path

Usage

This document uses the Desktop folder for command example.

tbx dropbox file info -path /DROPBOX/PATH/TO/FILE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path
`-peer`	Account alias	default

Results

Report: metadata

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. metadata.csv, metadata.json, and metadata.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
content_hash	A hash of the file content.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
shared_folder_id	If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
parent_shared_folder_id	ID of shared folder that holds this file.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; metadata_0000.xlsx, metadata_0001.xlsx, metadata_0002.xlsx, …

Title: dropbox file list URL: https://toolbox.watermint.org/commands/dropbox/file/list.md —

dropbox file list

List files and folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox file list -path /path

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-include-deleted`	Include deleted files	false
`-include-explicit-shared-members`	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.	false
`-include-mounted-folders`	If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.	false
`-path`	Path
`-peer`	Account alias	default
`-recursive`	List recursively	false

Results

Report: file_list

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. file_list.csv, file_list.json, and file_list.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_list_0000.xlsx, file_list_0001.xlsx, file_list_0002.xlsx, …

Title: dropbox file merge URL: https://toolbox.watermint.org/commands/dropbox/file/merge.md —

dropbox file merge

Merge paths (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file merge -from /from/path -to /path/to

Please add -dry-run=false option after verify integrity of expected result.

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dry-run`	Dry run	true
`-from`	Path for merge
`-keep-empty-folder`	Keep empty folder after merge	false
`-peer`	Account alias	default
`-to`	Path to merge
`-within-same-namespace`	Do not cross namespace. That is for preserve sharing permission including a shared link	false

Title: dropbox file move URL: https://toolbox.watermint.org/commands/dropbox/file/move.md —

dropbox file move

Move files (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file move -src /SRC/PATH -dst /DST/PATH

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dst`	Destination path
`-peer`	Account alias	default
`-src`	Source path

Title: dropbox file replication URL: https://toolbox.watermint.org/commands/dropbox/file/replication.md —

dropbox file replication

Replicate file content to the other account (Irreversible operation)

This command will replicate files/folders. But it does not include sharing permissions. The command replicates only for folder contents of given path.

Usage

This document uses the Desktop folder for command example.

tbx dropbox file replication -src source -src-path /path/src -dst dest -dst-path /path/dest

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dst`	Account alias (destionation)	dst
`-dst-path`	Destination path
`-src`	Account alias (source)	src
`-src-path`	Source path

Results

Report: replication_diff

This report shows a difference between to folders. The command will generate a report in three different formats. replication_diff.csv, replication_diff.json, and replication_diff.xlsx.

Column	Description
diff_type	Type of difference. `file_content_diff`: different content hash, `{left\|right}_file_missing`: left or right file missing, `{left\|right}_folder_missing`: left or right folder missing.
left_path	path of left
left_kind	folder or file
left_size	size of left file
left_hash	Content hash of left file
right_path	path of right
right_kind	folder of file
right_size	size of right file
right_hash	Content hash of right file

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; replication_diff_0000.xlsx, replication_diff_0001.xlsx, replication_diff_0002.xlsx, …

Title: dropbox file size URL: https://toolbox.watermint.org/commands/dropbox/file/size.md —

dropbox file size

Storage usage

Usage

This document uses the Desktop folder for command example.

tbx dropbox file size -path /

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-depth`	Report an entry for all files and folders depth folders deep	2
`-path`	Path to scan
`-peer`	Account alias	default

Results

Report: size

Folder size The command will generate a report in three different formats. size.csv, size.json, and size.xlsx.

Column	Description
path	Path
depth	Folder depth.
size	Size in bytes
num_file	Number of files in this folder and child folders
num_folder	Number of folders in this folder and child folders
mod_time_earliest	The earliest modification time of a file in this folder or child folders.
mod_time_latest	The latest modification time of a file in this folder or child folders.
operational_complexity	Operational complexity factor

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; size_0000.xlsx, size_0001.xlsx, size_0002.xlsx, …

Title: dropbox file watch URL: https://toolbox.watermint.org/commands/dropbox/file/watch.md —

dropbox file watch

Watch file activities

Usage

This document uses the Desktop folder for command example.

tbx dropbox file watch -path /DROPBOX/PATH/TO/WATCH

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path to watch
`-peer`	Account alias	default
`-recursive`	Watch path recursively	false

Title: dropbox file account feature URL: https://toolbox.watermint.org/commands/dropbox/file/account/feature.md —

dropbox file account feature

List Dropbox account features

Usage

This document uses the Desktop folder for command example.

tbx dropbox file account feature

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: report

Feature setting for the user The command will generate a report in three different formats. report.csv, report.json, and report.xlsx.

Column	Description
paper_as_files	When this value is true, the user’s Paper docs are accessible in Dropbox with the .paper extension and must be accessed via the /files endpoints.
file_locking	When this value is True, the user can lock files in shared folders.
team_shared_dropbox	This feature contains information about whether or not the user is part of a team with a shared team root.
distinct_member_home	his feature contains information about whether or not the user’s home namespace is distinct from their root namespace.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; report_0000.xlsx, report_0001.xlsx, report_0002.xlsx, …

Title: dropbox file account filesystem URL: https://toolbox.watermint.org/commands/dropbox/file/account/filesystem.md —

dropbox file account filesystem

Show Dropbox file system version

Usage

This document uses the Desktop folder for command example.

tbx dropbox file account filesystem

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: file_system

File system version information The command will generate a report in three different formats. file_system.csv, file_system.json, and file_system.xlsx.

Column	Description
version	Version of the file system
release_year	Year of the file system release
has_distinct_member_homes	True if the team has distinct member home folder
has_team_shared_dropbox	True if the team has team shared Dropbox
is_team_folder_api_supported	True if team folder API is supported
is_path_root_required_to_access_team_folder	True if Dropbox-API-Path-Root is required to access team folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_system_0000.xlsx, file_system_0001.xlsx, file_system_0002.xlsx, …

Title: dropbox file account info URL: https://toolbox.watermint.org/commands/dropbox/file/account/info.md —

dropbox file account info

Dropbox account info

Usage

This document uses the Desktop folder for command example.

tbx dropbox file account info

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: profile

This report shows a list of members. The command will generate a report in three different formats. profile.csv, profile.json, and profile.xlsx.

Column	Description
email	Email address of user.
email_verified	Is true if the user’s email is verified to be owned by the user.
given_name	Also known as a first name
surname	Also known as a last name or family name.
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; profile_0000.xlsx, profile_0001.xlsx, profile_0002.xlsx, …

Title: dropbox file compare account URL: https://toolbox.watermint.org/commands/dropbox/file/compare/account.md —

dropbox file compare account

Compare files of two accounts

Usage

This document uses the Desktop folder for command example.

tbx dropbox file compare account -left left -left-path /path/to/compare -right right -right-path /path/to/compare

If you want to compare different path in same account, please specify same alias name to -left and -right.

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-left`	Account alias (left)	left
`-left-path`	The path from account root (left)
`-right`	Account alias (right)	right
`-right-path`	The path from account root (right)

Results

Report: diff

This report shows a difference between to folders. The command will generate a report in three different formats. diff.csv, diff.json, and diff.xlsx.

Column	Description
diff_type	Type of difference. `file_content_diff`: different content hash, `{left\|right}_file_missing`: left or right file missing, `{left\|right}_folder_missing`: left or right folder missing.
left_path	path of left
left_kind	folder or file
left_size	size of left file
left_hash	Content hash of left file
right_path	path of right
right_kind	folder of file
right_size	size of right file
right_hash	Content hash of right file

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; diff_0000.xlsx, diff_0001.xlsx, diff_0002.xlsx, …

Title: dropbox file compare local URL: https://toolbox.watermint.org/commands/dropbox/file/compare/local.md —

dropbox file compare local

Compare local folders and Dropbox folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox file compare local -local-path /path/to/local -dropbox-path /path/on/dropbox

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dropbox-path`	Dropbox path
`-local-path`	Local path
`-peer`	Account alias	default

Results

Report: diff

This report shows a difference between to folders. The command will generate a report in three different formats. diff.csv, diff.json, and diff.xlsx.

Column	Description
diff_type	Type of difference. `file_content_diff`: different content hash, `{left\|right}_file_missing`: left or right file missing, `{left\|right}_folder_missing`: left or right folder missing.
left_path	path of left
left_kind	folder or file
left_size	size of left file
left_hash	Content hash of left file
right_path	path of right
right_kind	folder of file
right_size	size of right file
right_hash	Content hash of right file

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; diff_0000.xlsx, diff_0001.xlsx, diff_0002.xlsx, …

Report: skip

This report shows a difference between to folders. The command will generate a report in three different formats. skip.csv, skip.json, and skip.xlsx.

Column	Description
diff_type	Type of difference. `file_content_diff`: different content hash, `{left\|right}_file_missing`: left or right file missing, `{left\|right}_folder_missing`: left or right folder missing.
left_path	path of left
left_kind	folder or file
left_size	size of left file
left_hash	Content hash of left file
right_path	path of right
right_kind	folder of file
right_size	size of right file
right_hash	Content hash of right file

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; skip_0000.xlsx, skip_0001.xlsx, skip_0002.xlsx, …

Title: dropbox file export doc URL: https://toolbox.watermint.org/commands/dropbox/file/export/doc.md —

dropbox file export doc

Export document (Experimental)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file export doc -dropbox-path /DROPBOX/PATH/TO/FILE -local-path /LOCAL/PATH/TO/EXPORT

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dropbox-path`	Dropbox document path to export.
`-format`	Export format
`-local-path`	Local path to save
`-peer`	Account alias	default

Results

Report: operation_log

This report shows a result of exporting file. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
export_name	File name for export file.
export_size	File size of export file.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file export url URL: https://toolbox.watermint.org/commands/dropbox/file/export/url.md —

dropbox file export url

Export a document from the URL

Usage

This document uses the Desktop folder for command example.

tbx dropbox file export url -local-path /LOCAL/PATH/TO/export -url DOCUMENT_URL

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-format`	Export format
`-local-path`	Local path to export
`-password`	Password for the shared link
`-peer`	Account alias	default
`-url`	URL of the document

Results

Report: operation_log

This report shows a result of exporting file. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
export_name	File name for export file.
export_size	File size of export file.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file import url URL: https://toolbox.watermint.org/commands/dropbox/file/import/url.md —

dropbox file import url

Import file from the URL (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file import url -url URL -path /path/to/import

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path to import
`-peer`	Account alias	default
`-url`	URL

Results

Report: operation_log

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file import batch url URL: https://toolbox.watermint.org/commands/dropbox/file/import/batch/url.md —

dropbox file import batch url

Batch import files from URL (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file import batch url -file /path/to/data/file -path /path/to/import

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-file`	Data file
`-path`	Path to import
`-peer`	Account alias	default

File formats

Format: File

Data file for batch import files from URLs.

Column	Description	Example
url	Url to download	http://example.com/2019/12/26.zip
path	Path to store file (use path given by `-path` when the record is empty)	/backup/2019-12-16.zip

The first line is a header line. The program will accept a file without the header.

url,path
http://example.com/2019/12/26.zip,/backup/2019-12-16.zip

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Url to download
input.path	Path to store file (use path given by `-path` when the record is empty)
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.name	The last component of the path (including extension).
result.path_display	The cased path to be used for display purposes only.
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file lock acquire URL: https://toolbox.watermint.org/commands/dropbox/file/lock/acquire.md —

dropbox file lock acquire

Lock a file

Usage

This document uses the Desktop folder for command example.

tbx dropbox file lock acquire -path /DROPBOX/FILE/PATH/TO/LOCK

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	File path to lock
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file lock list URL: https://toolbox.watermint.org/commands/dropbox/file/lock/list.md —

dropbox file lock list

List locks under the specified path

Usage

This document uses the Desktop folder for command example.

tbx dropbox file lock list -path /DROPBOX/PATH/TO/SEARCH/LOCK

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path
`-peer`	Account alias	default

Results

Report: lock

Lock information The command will generate a report in three different formats. lock.csv, lock.json, and lock.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.
is_lock_holder	True if caller holds the file lock
lock_holder_name	The display name of the lock holder.
lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; lock_0000.xlsx, lock_0001.xlsx, lock_0002.xlsx, …

Title: dropbox file lock release URL: https://toolbox.watermint.org/commands/dropbox/file/lock/release.md —

dropbox file lock release

Release a lock

Usage

This document uses the Desktop folder for command example.

tbx dropbox file lock release -path /DROPBOX/FILE/PATH/TO/UNLOCK

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path to the file
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file lock all release URL: https://toolbox.watermint.org/commands/dropbox/file/lock/all/release.md —

dropbox file lock all release

Release all locks under the specified path

Usage

This document uses the Desktop folder for command example.

tbx dropbox file lock all release -path /DROPBOX/PATH/TO/RELEASE/LOCK

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-batch-size`	Operation batch size	100
`-path`	Path to release locks
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file lock batch acquire URL: https://toolbox.watermint.org/commands/dropbox/file/lock/batch/acquire.md —

dropbox file lock batch acquire

Lock multiple files

Usage

This document uses the Desktop folder for command example.

tbx dropbox file lock batch acquire -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-batch-size`	Operation batch size	100
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Path

Column	Description	Example
path	Path to the file	/Report/2021-02.xlsx

The first line is a header line. The program will accept a file without the header.

path
/Report/2021-02.xlsx

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path to the file
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file lock batch release URL: https://toolbox.watermint.org/commands/dropbox/file/lock/batch/release.md —

dropbox file lock batch release

Release multiple locks

Usage

This document uses the Desktop folder for command example.

tbx dropbox file lock batch release -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Path

Column	Description	Example
path	Path to the file	/Report/2021-02.xlsx

The first line is a header line. The program will accept a file without the header.

path
/Report/2021-02.xlsx

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path to the file
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file request create URL: https://toolbox.watermint.org/commands/dropbox/file/request/create.md —

dropbox file request create

Create a file request (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file request create -path /DROPBOX/PATH/OF/FILE_REQUEST -title TITLE

Options:

Option	Description	Default
`-allow-late-uploads`	If set, allow uploads after the deadline has passed (one_day/two_days/seven_days/thirty_days/always)
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-deadline`	The deadline for this file request.
`-path`	The path for the folder in the Dropbox where uploaded files will be sent.
`-peer`	Account alias	default
`-title`	The title of the file request

Results

Report: file_request

This report shows a list of file requests. The command will generate a report in three different formats. file_request.csv, file_request.json, and file_request.xlsx.

Column	Description
id	The Id of the file request
url	The URL of the file request
title	The title of the file request
created	Date/time of the file request was created.
is_open	Whether or not the file request is open.
file_count	The number of files this file request has received.
destination	The path for the folder in the Dropbox where uploaded files will be sent.
deadline	The deadline for this file request.
deadline_allow_late_uploads	If set, allow uploads after the deadline has passed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_request_0000.xlsx, file_request_0001.xlsx, file_request_0002.xlsx, …

Title: dropbox file request list URL: https://toolbox.watermint.org/commands/dropbox/file/request/list.md —

dropbox file request list

List file requests of the individual account

Usage

This document uses the Desktop folder for command example.

tbx dropbox file request list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: file_requests

This report shows a list of file requests. The command will generate a report in three different formats. file_requests.csv, file_requests.json, and file_requests.xlsx.

Column	Description
id	The Id of the file request
url	The URL of the file request
title	The title of the file request
created	Date/time of the file request was created.
is_open	Whether or not the file request is open.
file_count	The number of files this file request has received.
destination	The path for the folder in the Dropbox where uploaded files will be sent.
deadline	The deadline for this file request.
deadline_allow_late_uploads	If set, allow uploads after the deadline has passed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_requests_0000.xlsx, file_requests_0001.xlsx, file_requests_0002.xlsx, …

Title: dropbox file request delete closed URL: https://toolbox.watermint.org/commands/dropbox/file/request/delete/closed.md —

dropbox file request delete closed

Delete all closed file requests on this account. (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file request delete closed

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: deleted

This report shows a list of file requests. The command will generate a report in three different formats. deleted.csv, deleted.json, and deleted.xlsx.

Column	Description
id	The Id of the file request
url	The URL of the file request
title	The title of the file request
created	Date/time of the file request was created.
is_open	Whether or not the file request is open.
file_count	The number of files this file request has received.
destination	The path for the folder in the Dropbox where uploaded files will be sent.
deadline	The deadline for this file request.
deadline_allow_late_uploads	If set, allow uploads after the deadline has passed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; deleted_0000.xlsx, deleted_0001.xlsx, deleted_0002.xlsx, …

Title: dropbox file request delete url URL: https://toolbox.watermint.org/commands/dropbox/file/request/delete/url.md —

dropbox file request delete url

Delete a file request by the file request URL (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file request delete url -url URL

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-force`	Force delete the file request.	false
`-peer`	Account alias	default
`-url`	URL of the file request.

Results

Report: deleted

This report shows a list of file requests. The command will generate a report in three different formats. deleted.csv, deleted.json, and deleted.xlsx.

Column	Description
id	The Id of the file request
url	The URL of the file request
title	The title of the file request
created	Date/time of the file request was created.
is_open	Whether or not the file request is open.
file_count	The number of files this file request has received.
destination	The path for the folder in the Dropbox where uploaded files will be sent.
deadline	The deadline for this file request.
deadline_allow_late_uploads	If set, allow uploads after the deadline has passed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; deleted_0000.xlsx, deleted_0001.xlsx, deleted_0002.xlsx, …

Title: dropbox file restore all URL: https://toolbox.watermint.org/commands/dropbox/file/restore/all.md —

dropbox file restore all

Restore files under given path (Experimental, and Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file restore all -path /DROPBOX/PATH/TO/RESTORE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.name	The last component of the path (including extension).
result.path_display	The cased path to be used for display purposes only.
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file restore ext URL: https://toolbox.watermint.org/commands/dropbox/file/restore/ext.md —

dropbox file restore ext

Restore files with a specific extension (Experimental, and Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file restore ext -ext EXT -path /DROPBOX/PATH/TO/RESTORE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-ext`	Extension to restore (e.g. jpg, png, pdf)
`-path`	Path to restore
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.name	The last component of the path (including extension).
result.path_display	The cased path to be used for display purposes only.
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox file revision download URL: https://toolbox.watermint.org/commands/dropbox/file/revision/download.md —

dropbox file revision download

Download the file revision

Usage

This document uses the Desktop folder for command example.

tbx dropbox file revision download -local-path /LOCAL/PATH/TO/DOWNLOAD -revision REVISION

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-local-path`	Local path to store downloaded file
`-peer`	Account alias	default
`-revision`	File revision

Results

Report: entry

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. entry.csv, entry.json, and entry.xlsx.

Column	Description
id	A unique identifier for the file.
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
content_hash	A hash of the file content.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; entry_0000.xlsx, entry_0001.xlsx, entry_0002.xlsx, …

Title: dropbox file revision list URL: https://toolbox.watermint.org/commands/dropbox/file/revision/list.md —

dropbox file revision list

List file revisions

Usage

This document uses the Desktop folder for command example.

tbx dropbox file revision list -path /DROPBOX/PATH/TO/FILE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	File path
`-peer`	Account alias	default

Results

Report: revisions

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. revisions.csv, revisions.json, and revisions.xlsx.

Column	Description
id	A unique identifier for the file.
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
content_hash	A hash of the file content.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; revisions_0000.xlsx, revisions_0001.xlsx, revisions_0002.xlsx, …

Title: dropbox file revision restore URL: https://toolbox.watermint.org/commands/dropbox/file/revision/restore.md —

dropbox file revision restore

Restore the file revision

Usage

This document uses the Desktop folder for command example.

tbx dropbox file revision restore -path /DROPBOX/PATH/TO/RESTORE -revision REVISION

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	File path
`-peer`	Account alias	default
`-revision`	File revision

Results

Report: entry

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. entry.csv, entry.json, and entry.xlsx.

Column	Description
id	A unique identifier for the file.
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
content_hash	A hash of the file content.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; entry_0000.xlsx, entry_0001.xlsx, entry_0002.xlsx, …

Title: dropbox file search content URL: https://toolbox.watermint.org/commands/dropbox/file/search/content.md —

dropbox file search content

Search file content

Usage

This document uses the Desktop folder for command example.

tbx dropbox file search content -query QUERY

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-category`	Restricts search to only the file categories specified (image/document/pdf/spreadsheet/presentation/audio/video/folder/paper/others).
`-extension`	Restricts search to only the extensions specified.
`-max-results`	Maximum number of entry to return	25
`-path`	Scopes the search to a path in the user’s Dropbox.
`-peer`	Account alias	default
`-query`	The string to search for.

Results

Report: matches

This report shows a result of search with highlighted text. The command will generate a report in three different formats. matches.csv, matches.json, and matches.xlsx.

Column	Description
tag	Type of entry
path_display	Display path
highlight_html	Highlighted text in HTML

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; matches_0000.xlsx, matches_0001.xlsx, matches_0002.xlsx, …

Title: dropbox file search name URL: https://toolbox.watermint.org/commands/dropbox/file/search/name.md —

dropbox file search name

Search file name

Usage

This document uses the Desktop folder for command example.

tbx dropbox file search name -query QUERY

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-category`	Restricts search to only the file categories specified (image/document/pdf/spreadsheet/presentation/audio/video/folder/paper/others).
`-extension`	Restricts search to only the extensions specified.
`-path`	Scopes the search to a path in the user’s Dropbox.
`-peer`	Account alias	default
`-query`	The string to search for.

Results

Report: matches

This report shows a result of search with highlighted text. The command will generate a report in three different formats. matches.csv, matches.json, and matches.xlsx.

Column	Description
tag	Type of entry
path_display	Display path
highlight_html	Highlighted text in HTML

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; matches_0000.xlsx, matches_0001.xlsx, matches_0002.xlsx, …

Title: dropbox file share info URL: https://toolbox.watermint.org/commands/dropbox/file/share/info.md —

Retrieve sharing information of the file

Usage

This document uses the Desktop folder for command example.

tbx dropbox file share info -path /DROPBOX/PATH/TO/GET_INFO

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	File
`-peer`	Account alias	default

Results

Report: metadata

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. metadata.csv, metadata.json, and metadata.xlsx.

Column	Description
id	A unique identifier for the file.
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_lower	The lowercased full path in the user’s Dropbox. This always starts with a slash.
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
content_hash	A hash of the file content.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
shared_folder_id	If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
parent_shared_folder_id	ID of shared folder that holds this file.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; metadata_0000.xlsx, metadata_0001.xlsx, metadata_0002.xlsx, …

Title: dropbox file sharedfolder info URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/info.md —

dropbox file sharedfolder info

Get shared folder info

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder info -shared-folder-id NAMESPACE_ID

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default
`-shared-folder-id`	Namespace ID

Results

Report: policies

This report shows a list of shared folders. The command will generate a report in three different formats. policies.csv, policies.json, and policies.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policies_0000.xlsx, policies_0001.xlsx, policies_0002.xlsx, …

Title: dropbox file sharedfolder leave URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/leave.md —

dropbox file sharedfolder leave

Leave from the shared folder

Upon success, the current user will no longer have access to the folder. Please use dropbox file sharedfolder list command to find the shared_folder_id of the folder you want to leave.

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder leave -shared-folder-id SHARED_FOLDER_ID

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-keep-copy`	Keep a copy of the folder’s contents upon relinquishing membership.	false
`-peer`	Account alias	default
`-shared-folder-id`	The ID for the shared folder.

Title: dropbox file sharedfolder list URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/list.md —

dropbox file sharedfolder list

List shared folder(s)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: shared_folder

This report shows a list of shared folders. The command will generate a report in three different formats. shared_folder.csv, shared_folder.json, and shared_folder.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; shared_folder_0000.xlsx, shared_folder_0001.xlsx, shared_folder_0002.xlsx, …

Title: dropbox file sharedfolder share URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/share.md —

Share a folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder share -path /DROPBOX/PATH/TO/SHARE

Options:

Option	Description	Default
`-acl-update-policy`	Who can change a shared folder’s access control list (ACL).	owner
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-member-policy`	Who can be a member of this shared folder.	anyone
`-path`	Path to be shared
`-peer`	Account alias	default
`-shared-link-policy`	Who can view shared links in this folder.	anyone

Results

Report: shared

This report shows a list of shared folders. The command will generate a report in three different formats. shared.csv, shared.json, and shared.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
parent_shared_folder_id	The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_id	Team ID of the folder owner team
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; shared_0000.xlsx, shared_0001.xlsx, shared_0002.xlsx, …

Title: dropbox file sharedfolder unshare URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/unshare.md —

dropbox file sharedfolder unshare

Unshare a folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder unshare -path /DROPBOX/PATH/TO/UNSHARE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-leave-copy`	If true, members of this shared folder will get a copy of this folder after it’s unshared.	false
`-path`	Path to be unshared
`-peer`	Account alias	default

Title: dropbox file sharedfolder member add URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/member/add.md —

dropbox file sharedfolder member add

Add a member to the shared folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder member add -email EMAIL -path /DROPBOX/PATH/TO/ADD

Options:

Option	Description	Default
`-access-level`	Access type (viewer/editor)	editor
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-email`	Email address of the folder member
`-message`	Custom message for invitation
`-path`	Shared folder path of the member
`-peer`	Account alias	default
`-silent`	Do not send invitation email	false

Title: dropbox file sharedfolder member delete URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/member/delete.md —

dropbox file sharedfolder member delete

Delete a member from the shared folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder member delete -email EMAIL -path /DROPBOX/PATH/TO/DELETE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-email`	Email address of the folder member
`-leave-copy`	If true, members of this shared folder will get a copy of this folder after it’s unshared.	false
`-path`	Shared folder path of the member
`-peer`	Account alias	default

Title: dropbox file sharedfolder member list URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/member/list.md —

dropbox file sharedfolder member list

List shared folder member(s)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder member list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: member

This report shows a list of members of shared folders. The command will generate a report in three different formats. member.csv, member.json, and member.xlsx.

Column	Description
name	The name of the this shared folder.
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
is_inherited	True if the member has access from a parent folder
email	Email address of user.
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
group_name	Name of a group
invitee_email	Email address of invitee for this folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_0000.xlsx, member_0001.xlsx, member_0002.xlsx, …

Title: dropbox file sharedfolder mount add URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/mount/add.md —

dropbox file sharedfolder mount add

Add the shared folder to the current user’s Dropbox

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder mount add -shared-folder-id SHARED_FOLDER_ID

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default
`-shared-folder-id`	The ID for the shared folder.

Results

Report: mount

This report shows a list of shared folders. The command will generate a report in three different formats. mount.csv, mount.json, and mount.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mount_0000.xlsx, mount_0001.xlsx, mount_0002.xlsx, …

Title: dropbox file sharedfolder mount delete URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/mount/delete.md —

dropbox file sharedfolder mount delete

The current user unmounts the designated folder.

Upon success, the current user cannot access the folder unless adding the folder again. Please use dropbox file sharedfolder mount list command to find the shared_folder_id of the folder you want to delete.

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder mount delete -shared-folder-id SHARED_FOLDER_ID

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default
`-shared-folder-id`	The ID for the shared folder.

Results

Report: mount

This report shows a list of shared folders. The command will generate a report in three different formats. mount.csv, mount.json, and mount.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mount_0000.xlsx, mount_0001.xlsx, mount_0002.xlsx, …

Title: dropbox file sharedfolder mount list URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/mount/list.md —

dropbox file sharedfolder mount list

List all shared folders the current user mounted

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder mount list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: mounts

This report shows a list of shared folders. The command will generate a report in three different formats. mounts.csv, mounts.json, and mounts.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mounts_0000.xlsx, mounts_0001.xlsx, mounts_0002.xlsx, …

Title: dropbox file sharedfolder mount mountable URL: https://toolbox.watermint.org/commands/dropbox/file/sharedfolder/mount/mountable.md —

dropbox file sharedfolder mount mountable

List all shared folders the current user can mount

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedfolder mount mountable

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-include-mounted`	Include mounted folders.	false
`-peer`	Account alias	default

Results

Report: mountables

This report shows a list of shared folders. The command will generate a report in three different formats. mountables.csv, mountables.json, and mountables.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mountables_0000.xlsx, mountables_0001.xlsx, mountables_0002.xlsx, …

Title: dropbox file sharedlink create URL: https://toolbox.watermint.org/commands/dropbox/file/sharedlink/create.md —

dropbox file sharedlink create

Create shared link (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedlink create -path /path/to/share

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-expires`	Expiration date/time of the shared link
`-password`	Password
`-path`	Path
`-peer`	Account alias	default
`-team-only`	Link is accessible only by team members	false

Results

Report: created

THis report shows a list of shared links. The command will generate a report in three different formats. created.csv, created.json, and created.xlsx.

Column	Description
id	A unique identifier for the linked file or folder
tag	Entry type (file, or folder)
url	URL of the shared link.
name	The linked file name (including extension).
expires	Expiration time, if set.
path_lower	The lowercased full path in the user’s Dropbox.
visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; created_0000.xlsx, created_0001.xlsx, created_0002.xlsx, …

Title: dropbox file sharedlink delete URL: https://toolbox.watermint.org/commands/dropbox/file/sharedlink/delete.md —

dropbox file sharedlink delete

Remove shared links (Irreversible operation)

This command will delete shared links based on the path in the Dropbox

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedlink delete -path /path/to/delete

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	File or folder path to remove shared link
`-peer`	Account alias	default
`-recursive`	Attempt to remove the file hierarchy	false

Results

Report: shared_link

This report shows the transaction result. The command will generate a report in three different formats. shared_link.csv, shared_link.json, and shared_link.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.tag	Entry type (file, or folder)
input.url	URL of the shared link.
input.name	The linked file name (including extension).
input.expires	Expiration time, if set.
input.path_lower	The lowercased full path in the user’s Dropbox.
input.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; shared_link_0000.xlsx, shared_link_0001.xlsx, shared_link_0002.xlsx, …

Title: dropbox file sharedlink info URL: https://toolbox.watermint.org/commands/dropbox/file/sharedlink/info.md —

dropbox file sharedlink info

Get information about the shared link

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedlink info -url SHARED_LINK_URL

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-password`	Password of the link if required.
`-peer`	Account alias	default
`-url`	URL of the shared link

Results

Report: shared_link

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. shared_link.csv, shared_link.json, and shared_link.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_lower	The lowercased full path in the user’s Dropbox. This always starts with a slash.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; shared_link_0000.xlsx, shared_link_0001.xlsx, shared_link_0002.xlsx, …

Title: dropbox file sharedlink list URL: https://toolbox.watermint.org/commands/dropbox/file/sharedlink/list.md —

dropbox file sharedlink list

List of shared link(s)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedlink list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: shared_link

THis report shows a list of shared links. The command will generate a report in three different formats. shared_link.csv, shared_link.json, and shared_link.xlsx.

Column	Description
tag	Entry type (file, or folder)
url	URL of the shared link.
name	The linked file name (including extension).
expires	Expiration time, if set.
path_lower	The lowercased full path in the user’s Dropbox.
visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; shared_link_0000.xlsx, shared_link_0001.xlsx, shared_link_0002.xlsx, …

Title: dropbox file sharedlink file list URL: https://toolbox.watermint.org/commands/dropbox/file/sharedlink/file/list.md —

dropbox file sharedlink file list

List files for the shared link

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sharedlink file list -url SHAREDLINK_URL

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-password`	Password for the shared link
`-peer`	Account alias	default
`-url`	Shared link URL

Results

Report: file_list

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. file_list.csv, file_list.json, and file_list.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_list_0000.xlsx, file_list_0001.xlsx, file_list_0002.xlsx, …

Title: dropbox file sync down URL: https://toolbox.watermint.org/commands/dropbox/file/sync/down.md —

dropbox file sync down

Downstream sync with Dropbox

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sync down -dropbox-path /DROPBOX/PATH/TO/DOWNLOAD -local-path /LOCAL/PATH/TO/SAVE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-delete`	Delete local file if a file removed on Dropbox	false
`-dropbox-path`	Dropbox path
`-local-path`	Local path
`-name-disable-ignore`	Filter by name. Filter system file or ignore files.
`-name-name`	Filter by name. Filter by exact match to the name.
`-name-name-prefix`	Filter by name. Filter by name match to the prefix.
`-name-name-suffix`	Filter by name. Filter by name match to the suffix.
`-peer`	Account alias	default
`-skip-existing`	Skip existing files. Do not overwrite	false

Results

Report: deleted

Path The command will generate a report in three different formats. deleted.csv, deleted.json, and deleted.xlsx.

Column	Description
entry_path	Path
entry_shard.file_system_type	File system type
entry_shard.shard_id	Shard ID
entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; deleted_0000.xlsx, deleted_0001.xlsx, deleted_0002.xlsx, …

Report: downloaded

This report shows the transaction result. The command will generate a report in three different formats. downloaded.csv, downloaded.json, and downloaded.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.name	The last component of the path (including extension).
input.path_display	The cased path to be used for display purposes only.
input.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
input.server_modified	The last time the file was modified on Dropbox.
input.size	The file size in bytes.
input.content_hash	A hash of the file content.
input.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
result.path	Path

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; downloaded_0000.xlsx, downloaded_0001.xlsx, downloaded_0002.xlsx, …

Report: skipped

This report shows the transaction result. The command will generate a report in three different formats. skipped.csv, skipped.json, and skipped.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.entry_path	Path
input.entry_shard.file_system_type	File system type
input.entry_shard.shard_id	Shard ID
input.entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; skipped_0000.xlsx, skipped_0001.xlsx, skipped_0002.xlsx, …

Report: summary

This report shows a summary of the upload results. The command will generate a report in three different formats. summary.csv, summary.json, and summary.xlsx.

Column	Description
start	Time of start
end	Time of finish
num_bytes	Total upload size (Bytes)
num_files_error	The number of files failed or got an error.
num_files_transferred	The number of files uploaded/downloaded.
num_files_skip	The number of files skipped or to skip.
num_folder_created	Number of created folders.
num_delete	Number of deleted entry.
num_api_call	The number of estimated upload API call for upload.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; summary_0000.xlsx, summary_0001.xlsx, summary_0002.xlsx, …

Title: dropbox file sync online URL: https://toolbox.watermint.org/commands/dropbox/file/sync/online.md —

dropbox file sync online

Sync online files (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sync online -src /DROPBOX/PATH/SRC -dst /DROPBOX/PATH/DST

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-delete`	Delete file if a file removed in source path	false
`-dst`	Destination path
`-name-disable-ignore`	Filter by name. Filter system file or ignore files.
`-name-name`	Filter by name. Filter by exact match to the name.
`-name-name-prefix`	Filter by name. Filter by name match to the prefix.
`-name-name-suffix`	Filter by name. Filter by name match to the suffix.
`-peer`	Account alias	default
`-skip-existing`	Skip existing files. Do not overwrite	false
`-src`	Source path

Results

Report: deleted

Path The command will generate a report in three different formats. deleted.csv, deleted.json, and deleted.xlsx.

Column	Description
entry_path	Path
entry_shard.file_system_type	File system type
entry_shard.shard_id	Shard ID
entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; deleted_0000.xlsx, deleted_0001.xlsx, deleted_0002.xlsx, …

Report: skipped

This report shows the transaction result. The command will generate a report in three different formats. skipped.csv, skipped.json, and skipped.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.entry_path	Path
input.entry_shard.file_system_type	File system type
input.entry_shard.shard_id	Shard ID
input.entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; skipped_0000.xlsx, skipped_0001.xlsx, skipped_0002.xlsx, …

Report: summary

This report shows a summary of the upload results. The command will generate a report in three different formats. summary.csv, summary.json, and summary.xlsx.

Column	Description
start	Time of start
end	Time of finish
num_bytes	Total upload size (Bytes)
num_files_error	The number of files failed or got an error.
num_files_transferred	The number of files uploaded/downloaded.
num_files_skip	The number of files skipped or to skip.
num_folder_created	Number of created folders.
num_delete	Number of deleted entry.
num_api_call	The number of estimated upload API call for upload.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; summary_0000.xlsx, summary_0001.xlsx, summary_0002.xlsx, …

Report: uploaded

This report shows the transaction result. The command will generate a report in three different formats. uploaded.csv, uploaded.json, and uploaded.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.name	The last component of the path (including extension).
result.path_display	The cased path to be used for display purposes only.
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.content_hash	A hash of the file content.
result.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; uploaded_0000.xlsx, uploaded_0001.xlsx, uploaded_0002.xlsx, …

Title: dropbox file sync up URL: https://toolbox.watermint.org/commands/dropbox/file/sync/up.md —

dropbox file sync up

Upstream sync with Dropbox (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox file sync up -dropbox-path /DROPBOX/PATH/TO/UPLOAD -local-path /LOCAL/PATH/OF/CONTENT

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-batch-size`	Batch commit size	50
`-delete`	Delete Dropbox file if a file removed locally	false
`-dropbox-path`	Destination Dropbox path
`-local-path`	Local file path
`-name-disable-ignore`	Filter by name. Filter system file or ignore files.
`-name-name`	Filter by name. Filter by exact match to the name.
`-name-name-prefix`	Filter by name. Filter by name match to the prefix.
`-name-name-suffix`	Filter by name. Filter by name match to the suffix.
`-overwrite`	Overwrite existing file on the target path if that exists.	false
`-peer`	Account alias	default

Results

Report: deleted

Path The command will generate a report in three different formats. deleted.csv, deleted.json, and deleted.xlsx.

Column	Description
entry_path	Path
entry_shard.file_system_type	File system type
entry_shard.shard_id	Shard ID
entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; deleted_0000.xlsx, deleted_0001.xlsx, deleted_0002.xlsx, …

Report: skipped

This report shows the transaction result. The command will generate a report in three different formats. skipped.csv, skipped.json, and skipped.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.entry_path	Path
input.entry_shard.file_system_type	File system type
input.entry_shard.shard_id	Shard ID
input.entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; skipped_0000.xlsx, skipped_0001.xlsx, skipped_0002.xlsx, …

Report: summary

This report shows a summary of the upload results. The command will generate a report in three different formats. summary.csv, summary.json, and summary.xlsx.

Column	Description
start	Time of start
end	Time of finish
num_bytes	Total upload size (Bytes)
num_files_error	The number of files failed or got an error.
num_files_transferred	The number of files uploaded/downloaded.
num_files_skip	The number of files skipped or to skip.
num_folder_created	Number of created folders.
num_delete	Number of deleted entry.
num_api_call	The number of estimated upload API call for upload.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; summary_0000.xlsx, summary_0001.xlsx, summary_0002.xlsx, …

Report: uploaded

This report shows the transaction result. The command will generate a report in three different formats. uploaded.csv, uploaded.json, and uploaded.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.name	The last component of the path (including extension).
result.path_display	The cased path to be used for display purposes only.
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.content_hash	A hash of the file content.
result.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; uploaded_0000.xlsx, uploaded_0001.xlsx, uploaded_0002.xlsx, …

Title: dropbox file tag add URL: https://toolbox.watermint.org/commands/dropbox/file/tag/add.md —

dropbox file tag add

Add tag to file or folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox file tag add -path /DROPBOX/PATH/TO/TARGET -tag TAG_NAME

Options:

Option	Description	Default
`-base-path`	Base path for adding a tag.	root
`-path`	File or folder path to add a tag.
`-peer`	Account alias	default
`-tag`	Tag to add to the file or folder.

Title: dropbox file tag delete URL: https://toolbox.watermint.org/commands/dropbox/file/tag/delete.md —

dropbox file tag delete

Delete a tag from the file/folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox file tag delete -path /DROPBOX/PATH/TO/PROCESS -tag TAG_NAME

Options:

Option	Description	Default
`-base-path`	Base path for removing a tag.	root
`-path`	File or folder path to remove a tag.
`-peer`	Account alias	default
`-tag`	Tag name

Title: dropbox file tag list URL: https://toolbox.watermint.org/commands/dropbox/file/tag/list.md —

List tags of the path

Usage

This document uses the Desktop folder for command example.

tbx dropbox file tag list -path /DROPBOX/PATH/TO/TARGET

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Target path
`-peer`	Account alias	default

Results

Report: tags

File tag The command will generate a report in three different formats. tags.csv, tags.json, and tags.xlsx.

Column	Description
path	File path
tag	File tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; tags_0000.xlsx, tags_0001.xlsx, tags_0002.xlsx, …

Title: dropbox file template apply URL: https://toolbox.watermint.org/commands/dropbox/file/template/apply.md —

dropbox file template apply

Apply file/folder structure template to the Dropbox path

Usage

This document uses the Desktop folder for command example.

tbx dropbox file template apply -path /DROPBOX/PATH/TO/APPLY -template /LOCAL/PATH/TO/template.json

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-path`	Path to apply template
`-peer`	Account alias	default
`-template`	Path to template file

Title: dropbox file template capture URL: https://toolbox.watermint.org/commands/dropbox/file/template/capture.md —

dropbox file template capture

Capture file/folder structure as template from Dropbox path

Usage

This document uses the Desktop folder for command example.

tbx dropbox file template capture -out /LOCAL/PATH/template.json -path /DROPBOX/PATH/TO/CAPTURE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-out`	Template output path
`-path`	Capture target path
`-peer`	Account alias	default

Title: dropbox paper append URL: https://toolbox.watermint.org/commands/dropbox/paper/append.md —

dropbox paper append

Append the content to the end of the existing Paper doc

Usage

This document uses the Desktop folder for command example.

tbx dropbox paper append -content /LOCAL/PATH/TO/INPUT.txt -path /DROPBOX/PATH/TO/APPEND.paper

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-content`	Paper content
`-format`	Import format (html/markdown/plain_text)	markdown
`-path`	Path in the user’s Dropbox
`-peer`	Account alias	default

Results

Report: created

Create/updated paper data The command will generate a report in three different formats. created.csv, created.json, and created.xlsx.

Column	Description
paper_revision	Paper revision

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; created_0000.xlsx, created_0001.xlsx, created_0002.xlsx, …

Text inputs

Text input: Content

Paper content

Title: dropbox paper create URL: https://toolbox.watermint.org/commands/dropbox/paper/create.md —

dropbox paper create

Create new Paper in the path

Usage

This document uses the Desktop folder for command example.

tbx dropbox paper create -content /LOCAL/PATH/TO/INPUT.txt -path /DROPBOX/PATH/TO/CREATE.paper

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-content`	Paper content
`-format`	Import format (html/markdown/plain_text)	markdown
`-path`	Path in the user’s Dropbox
`-peer`	Account alias	default

Results

Report: created

Create/updated paper data The command will generate a report in three different formats. created.csv, created.json, and created.xlsx.

Column	Description
url	URL of the Paper
result_path	Result path
paper_revision	Paper revision

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; created_0000.xlsx, created_0001.xlsx, created_0002.xlsx, …

Text inputs

Text input: Content

Paper content

Title: dropbox paper overwrite URL: https://toolbox.watermint.org/commands/dropbox/paper/overwrite.md —

dropbox paper overwrite

Overwrite existing Paper document

Usage

This document uses the Desktop folder for command example.

tbx dropbox paper overwrite -content /LOCAL/PATH/TO/INPUT.txt -path /DROPBOX/PATH/TO/OVERWRITE.paper

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-content`	Paper content
`-format`	Import format (html/markdown/plain_text)	markdown
`-path`	Path in the user’s Dropbox
`-peer`	Account alias	default

Results

Report: created

Create/updated paper data The command will generate a report in three different formats. created.csv, created.json, and created.xlsx.

Column	Description
paper_revision	Paper revision

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; created_0000.xlsx, created_0001.xlsx, created_0002.xlsx, …

Text inputs

Text input: Content

Paper content

Title: dropbox paper prepend URL: https://toolbox.watermint.org/commands/dropbox/paper/prepend.md —

dropbox paper prepend

Append the content to the beginning of the existing Paper doc

Usage

This document uses the Desktop folder for command example.

tbx dropbox paper prepend -content /LOCAL/PATH/TO/INPUT.txt -path /DROPBOX/PATH/TO/PREPEND.paper

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-content`	Paper content
`-format`	Import format (html/markdown/plain_text)	markdown
`-path`	Path in the user’s Dropbox
`-peer`	Account alias	default

Results

Report: created

Create/updated paper data The command will generate a report in three different formats. created.csv, created.json, and created.xlsx.

Column	Description
paper_revision	Paper revision

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; created_0000.xlsx, created_0001.xlsx, created_0002.xlsx, …

Text inputs

Text input: Content

Paper content

Title: dropbox sign request list URL: https://toolbox.watermint.org/commands/dropbox/sign/request/list.md —

dropbox sign request list

List signature requests

Usage

This document uses the Desktop folder for command example.

tbx dropbox sign request list

Options:

Option	Description	Default
`-account-id`	Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
`-peer`	Account alias	default

Results

Report: requests

Signature request The command will generate a report in three different formats. requests.csv, requests.json, and requests.xlsx.

Column	Description
signature_request_id	The id of the SignatureRequest.
requester_email_address	The email address of the initiator of the SignatureRequest.
title	The title the specified Account uses for the SignatureRequest.
subject	The subject in the email that was initially sent to the signers.
message	The custom message in the email that was initially sent to the signers.
created_at_rfc3339	Time the signature request was created.
expires_at_rfc3339	The time when the signature request will expire unsigned signatures.
is_complete	Whether or not the SignatureRequest has been fully executed by all signers.
is_declined	Whether or not the SignatureRequest has been declined by a signer.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; requests_0000.xlsx, requests_0001.xlsx, requests_0002.xlsx, …

Title: dropbox sign request signature list URL: https://toolbox.watermint.org/commands/dropbox/sign/request/signature/list.md —

dropbox sign request signature list

List signatures of requests

Usage

This document uses the Desktop folder for command example.

tbx dropbox sign request signature list

Options:

Option	Description	Default
`-account-id`	Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
`-peer`	Account alias	default

Results

Report: signatures

Signature data of a request. The command will generate a report in three different formats. signatures.csv, signatures.json, and signatures.xlsx.

Column	Description
signature_request_id	The id of the SignatureRequest.
signature_id	Signature identifier.
requester_email_address	The email address of the initiator of the SignatureRequest.
title	The title the specified Account uses for the SignatureRequest.
subject	The subject in the email that was initially sent to the signers.
message	The custom message in the email that was initially sent to the signers.
created_at_rfc3339	Time the signature request was created.
expires_at_rfc3339	The time when the signature request will expire unsigned signatures.
is_complete	Whether or not the SignatureRequest has been fully executed by all signers.
is_declined	Whether or not the SignatureRequest has been declined by a signer.
signer_email_address	The email address of the signer.
signer_name	The name of the signer.
signer_role	The role of the signer.
order	If signer order is assigned this is the 0-based index for this signer.
status_code	The current status of the signature. eg: awaiting_signature, signed, declined.
decline_reason	The reason provided by the signer for declining the request.
signed_at_rfc3339	Time that the document was signed or empty.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; signatures_0000.xlsx, signatures_0001.xlsx, signatures_0002.xlsx, …

Title: dropbox team feature URL: https://toolbox.watermint.org/commands/dropbox/team/feature.md —

dropbox team feature

Team feature

Usage

This document uses the Desktop folder for command example.

tbx dropbox team feature

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: feature

Team feature The command will generate a report in three different formats. feature.csv, feature.json, and feature.xlsx.

Column	Description
upload_api_rate_limit	The number of upload API calls allowed per month.
upload_api_rate_limit_count	The number of upload API called this month.
has_team_shared_dropbox	Does this team have a shared team root.
has_team_file_events	Team supports file events
has_team_selective_sync	Team supports selective sync
has_distinct_member_homes	Team has distinct member home folders

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; feature_0000.xlsx, feature_0001.xlsx, feature_0002.xlsx, …

Title: dropbox team filesystem URL: https://toolbox.watermint.org/commands/dropbox/team/filesystem.md —

dropbox team filesystem

Identify team’s file system version

Usage

This document uses the Desktop folder for command example.

tbx dropbox team filesystem

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: file_system

File system version information The command will generate a report in three different formats. file_system.csv, file_system.json, and file_system.xlsx.

Column	Description
version	Version of the file system
release_year	Year of the file system release
has_distinct_member_homes	True if the team has distinct member home folder
has_team_shared_dropbox	True if the team has team shared Dropbox
is_team_folder_api_supported	True if team folder API is supported
is_path_root_required_to_access_team_folder	True if Dropbox-API-Path-Root is required to access team folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_system_0000.xlsx, file_system_0001.xlsx, file_system_0002.xlsx, …

Title: dropbox team info URL: https://toolbox.watermint.org/commands/dropbox/team/info.md —

dropbox team info

Team information

Usage

This document uses the Desktop folder for command example.

tbx dropbox team info

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: info

This report shows a list of team information. The command will generate a report in three different formats. info.csv, info.json, and info.xlsx.

Column	Description
name	The name of the team
team_id	The ID of the team.
num_licensed_users	The number of licenses available to the team.
num_provisioned_users	The number of accounts that have been invited or are already active members of the team.
policy_shared_folder_member	Which shared folders team members can join (from_team_only, or from_anyone)
policy_shared_folder_join	Who can join folders shared by team members (team, or anyone)
policy_shared_link_create	Who can view shared links owned by team members (default_public, default_team_only, or team_only)
policy_emm_state	This describes the Enterprise Mobility Management (EMM) state for this team (disabled, optional, or required)
policy_office_add_in	The admin policy around the Dropbox Office Add-In for this team (disabled, or enabled)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; info_0000.xlsx, info_0001.xlsx, info_0002.xlsx, …

Title: dropbox team activity event URL: https://toolbox.watermint.org/commands/dropbox/team/activity/event.md —

dropbox team activity event

Event log

From release 91, the command parses -start-time or -end-time as the relative duration from now with the format like “-24h” (24 hours) or “-10m” (10 minutes). If you wanted to retrieve events every hour, then run like:

tbx team activity event -start-time -1h -output json > latest_events.json

Then, append the latest part to the entire log if you want.

cat latest_events.json >> all.json

Or more precisely, retrieve events every hour with some overlap.

tbx team activity event -start-time -1h5m -output json > latest_events.json

Then, concatenate, and de-duplicate overlapped events:

cat all.json latest_events.json | sort -u > _all.json && mv _all.json all.json

If you prefer CSV format, then use the jq command to convert it.

cat latest_events.json | jq -r '[.timestamp, .actor[.actor.".tag"].display_name, .actor[.actor.".tag"].email, .event_type.description, .event_category.".tag", .origin.access_method.end_user.".tag", .origin.geo_location.ip_address, .origin.geo_location.country, .origin.geo_location.city, .involve_non_team_member, (.participants | @text), (.context | @text)] | @csv' >> all.csv

Usage

This document uses the Desktop folder for command example.

tbx dropbox team activity event

Options:

Option	Description	Default
`-category`	Filter the returned events to a single category. This field is optional.
`-end-time`	Ending time (exclusive).
`-peer`	Account alias	default
`-start-time`	Starting time (inclusive)

Results

Report: event

This report shows an activity logs with mostly compatible with Dropbox for teams’s activity logs. The command will generate a report in three different formats. event.csv, event.json, and event.xlsx.

Column	Description
timestamp	The Dropbox timestamp representing when the action was taken.
member	User display name
member_email	User email address
event_type	The particular type of action taken.
category	Category of the events in event audit log.
access_method	The method that was used to perform the action.
ip_address	IP Address.
country	Country code.
city	City name
involve_non_team_members	True if the action involved a non team member either as the actor or as one of the affected users.
participants	Zero or more users and/or groups that are affected by the action.
context	The user or team on whose behalf the actor performed the action.
assets	Zero or more content assets involved in the action.
other_info	The variable event schema applicable to this type of action.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; event_0000.xlsx, event_0001.xlsx, event_0002.xlsx, …

Title: dropbox team activity user URL: https://toolbox.watermint.org/commands/dropbox/team/activity/user.md —

dropbox team activity user

Activities log per user

Usage

This document uses the Desktop folder for command example.

tbx dropbox team activity user

Options:

Option	Description	Default
`-category`	Filter the returned events to a single category. This field is optional.
`-end-time`	Ending time (exclusive).
`-peer`	Account alias	default
`-start-time`	Starting time (inclusive)

Results

Report: user

This report shows an activity logs with mostly compatible with Dropbox for teams’s activity logs. The command will generate a report in three different formats. user.csv, user.json, and user.xlsx.

Column	Description
timestamp	The Dropbox timestamp representing when the action was taken.
member	User display name
member_email	User email address
event_type	The particular type of action taken.
category	Category of the events in event audit log.
access_method	The method that was used to perform the action.
ip_address	IP Address.
country	Country code.
city	City name
involve_non_team_members	True if the action involved a non team member either as the actor or as one of the affected users.
participants	Zero or more users and/or groups that are affected by the action.
context	The user or team on whose behalf the actor performed the action.
assets	Zero or more content assets involved in the action.
other_info	The variable event schema applicable to this type of action.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; user_0000.xlsx, user_0001.xlsx, user_0002.xlsx, …

Report: user_summary

This report shows the transaction result. The command will generate a report in three different formats. user_summary.csv, user_summary.json, and user_summary.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.user	User email address
result.logins	Number of login activities
result.devices	Number of device activities
result.sharing	Number of sharing activities
result.file_operations	Number of file operation activities
result.paper	Number of activities of Paper
result.others	Number of other category activities

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; user_summary_0000.xlsx, user_summary_0001.xlsx, user_summary_0002.xlsx, …

Title: dropbox team activity batch user URL: https://toolbox.watermint.org/commands/dropbox/team/activity/batch/user.md —

dropbox team activity batch user

Scan activities for multiple users

Usage

This document uses the Desktop folder for command example.

tbx dropbox team activity batch user -file /path/to/file.csv

Options:

Option	Description	Default
`-category`	Filter the returned events to a single category. This field is optional.
`-end-time`	Ending time (exclusive).
`-file`	User email address list file
`-peer`	Account alias	default
`-start-time`	Starting time (inclusive)

File formats

Format: File

Data file for batch retrieve activities of members.

Column	Description	Example
email	User email address	john@example.com

The first line is a header line. The program will accept a file without the header.

email
john@example.com

Results

Report: combined

This report shows an activity logs with mostly compatible with Dropbox for teams’s activity logs. The command will generate a report in three different formats. combined.csv, combined.json, and combined.xlsx.

Column	Description
timestamp	The Dropbox timestamp representing when the action was taken.
member	User display name
member_email	User email address
event_type	The particular type of action taken.
category	Category of the events in event audit log.
access_method	The method that was used to perform the action.
ip_address	IP Address.
country	Country code.
city	City name
involve_non_team_members	True if the action involved a non team member either as the actor or as one of the affected users.
participants	Zero or more users and/or groups that are affected by the action.
context	The user or team on whose behalf the actor performed the action.
assets	Zero or more content assets involved in the action.
other_info	The variable event schema applicable to this type of action.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; combined_0000.xlsx, combined_0001.xlsx, combined_0002.xlsx, …

Report: user

Column	Description
timestamp	The Dropbox timestamp representing when the action was taken.
member	User display name
member_email	User email address
event_type	The particular type of action taken.
category	Category of the events in event audit log.
access_method	The method that was used to perform the action.
ip_address	IP Address.
country	Country code.
city	City name
involve_non_team_members	True if the action involved a non team member either as the actor or as one of the affected users.
participants	Zero or more users and/or groups that are affected by the action.
context	The user or team on whose behalf the actor performed the action.
assets	Zero or more content assets involved in the action.
other_info	The variable event schema applicable to this type of action.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; user_0000.xlsx, user_0001.xlsx, user_0002.xlsx, …

Title: dropbox team activity daily event URL: https://toolbox.watermint.org/commands/dropbox/team/activity/daily/event.md —

dropbox team activity daily event

Report activities by day

Usage

This document uses the Desktop folder for command example.

tbx dropbox team activity daily event -start-date DATE

Options:

Option	Description	Default
`-category`	Event category
`-end-date`	End date
`-peer`	Account alias	default
`-start-date`	Start date

Results

Report: event

Column	Description
timestamp	The Dropbox timestamp representing when the action was taken.
member	User display name
member_email	User email address
event_type	The particular type of action taken.
category	Category of the events in event audit log.
access_method	The method that was used to perform the action.
ip_address	IP Address.
country	Country code.
city	City name
involve_non_team_members	True if the action involved a non team member either as the actor or as one of the affected users.
participants	Zero or more users and/or groups that are affected by the action.
context	The user or team on whose behalf the actor performed the action.
assets	Zero or more content assets involved in the action.
other_info	The variable event schema applicable to this type of action.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; event_0000.xlsx, event_0001.xlsx, event_0002.xlsx, …

Title: dropbox team admin list URL: https://toolbox.watermint.org/commands/dropbox/team/admin/list.md —

dropbox team admin list

List admin roles of members

Usage

This document uses the Desktop folder for command example.

tbx dropbox team admin list

Options:

Option	Description	Default
`-include-non-admin`	Include non admin members in the report	false
`-member-roles`	Member to admin-role mappings
`-member-roles-format`	Output format
`-peer`	Account alias	default

Grid data output of the command

Grid data output: MemberRoles

Member to admin-role mappings

Title: dropbox team admin group role add URL: https://toolbox.watermint.org/commands/dropbox/team/admin/group/role/add.md —

dropbox team admin group role add

Add the role to members of the group

Usage

This document uses the Desktop folder for command example.

tbx dropbox team admin group role add -group GROUP_NAME -role-id ROLE_ID

Options:

Option	Description	Default
`-group`	Group name
`-peer`	Account alias	default
`-role-id`	Role ID

Results

Report: roles

The user’s roles in the team. The command will generate a report in three different formats. roles.csv, roles.json, and roles.xlsx.

Column	Description
team_member_id	Team member ID
email	Email address of the member
role_id	A string containing encoded role ID
name	The role display name.
description	Role description.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; roles_0000.xlsx, roles_0001.xlsx, roles_0002.xlsx, …

Title: dropbox team admin group role delete URL: https://toolbox.watermint.org/commands/dropbox/team/admin/group/role/delete.md —

dropbox team admin group role delete

Delete the role from all members except of members of the exception group

Usage

This document uses the Desktop folder for command example.

tbx dropbox team admin group role delete -exception-group GROUP_NAME -role-id ROLE_ID

Options:

Option	Description	Default
`-exception-group`	Exception group name
`-peer`	Account alias	default
`-role-id`	Role ID

Results

Report: roles

The user’s roles in the team. The command will generate a report in three different formats. roles.csv, roles.json, and roles.xlsx.

Column	Description
team_member_id	Team member ID
email	Email address of the member
role_id	A string containing encoded role ID
name	The role display name.
description	Role description.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; roles_0000.xlsx, roles_0001.xlsx, roles_0002.xlsx, …

Title: dropbox team admin role add URL: https://toolbox.watermint.org/commands/dropbox/team/admin/role/add.md —

dropbox team admin role add

Add a new role to the member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team admin role add -email EMAIL -role-id ROLE_ID

Options:

Option	Description	Default
`-email`	Email address of the member
`-peer`	Account alias	default
`-role-id`	Role ID

Results

Report: roles

The user’s roles in the team. The command will generate a report in three different formats. roles.csv, roles.json, and roles.xlsx.

Column	Description
team_member_id	Team member ID
email	Email address of the member
role_id	A string containing encoded role ID
name	The role display name.
description	Role description.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; roles_0000.xlsx, roles_0001.xlsx, roles_0002.xlsx, …

Title: dropbox team admin role clear URL: https://toolbox.watermint.org/commands/dropbox/team/admin/role/clear.md —

dropbox team admin role clear

Remove all admin roles from the member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team admin role clear -email EMAIL

Options:

Option	Description	Default
`-email`	Email address of the member
`-peer`	Account alias	default

Title: dropbox team admin role delete URL: https://toolbox.watermint.org/commands/dropbox/team/admin/role/delete.md —

dropbox team admin role delete

Remove a role from the member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team admin role delete -email EMAIL -role-id ROLE_ID

Options:

Option	Description	Default
`-email`	Email address of the member
`-peer`	Account alias	default
`-role-id`	Role ID

Results

Report: roles

The user’s roles in the team. The command will generate a report in three different formats. roles.csv, roles.json, and roles.xlsx.

Column	Description
team_member_id	Team member ID
email	Email address of the member
role_id	A string containing encoded role ID
name	The role display name.
description	Role description.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; roles_0000.xlsx, roles_0001.xlsx, roles_0002.xlsx, …

Title: dropbox team admin role list URL: https://toolbox.watermint.org/commands/dropbox/team/admin/role/list.md —

dropbox team admin role list

List admin roles of the team

Usage

This document uses the Desktop folder for command example.

tbx dropbox team admin role list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: roles

The user’s roles in the team. The command will generate a report in three different formats. roles.csv, roles.json, and roles.xlsx.

Column	Description
role_id	A string containing encoded role ID
name	The role display name.
description	Role description.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; roles_0000.xlsx, roles_0001.xlsx, roles_0002.xlsx, …

Title: dropbox team backup device status URL: https://toolbox.watermint.org/commands/dropbox/team/backup/device/status.md —

dropbox team backup device status

Dropbox Backup device status change in the specified period

Evaluates and reports the latest status of Dropbox Backup per device session from activity logs for a specified time period. If there is no activity during the specified period, it is reported as the value no_status_update. Multiple device sessions may be displayed in the following cases

If the Dropbox application has been reinstalled.
If the Dropbox application has not been unlinked (e.g. you initialized the OS without unlinking the Dropbox application).

in that case, please refer to the report session_info_updated to see the most recent report. This command does not automatically make this determination, since it is possible that there may be a session with the same hostname by coincidence.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team backup device status -start-time "2024-01-01"

Options:

Option	Description	Default
`-end-time`	End date/time of the period to retrieve data for (exclusive). If this is not specified, the current time is used.
`-peer`	Account alias	default
`-start-time`	Start date/time of the period to retrieve data for (inclusive).

Results

Report: devices

Backup feature status of a device The command will generate a report in three different formats. devices.csv, devices.json, and devices.xlsx.

Column	Description
actor_user_email	User email
actor_user_display_name	User display name
session_info_ip_address	IP address
session_info_host_name	Host name
session_info_updated	Last Date/time of the session update
session_info_client_type	Client type
session_info_client_version	Client version
session_info_platform	Platform
timestamp	Timestamp of the event
latest_status	Latest status of the device

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; devices_0000.xlsx, devices_0001.xlsx, devices_0002.xlsx, …

Title: dropbox team content legacypaper count URL: https://toolbox.watermint.org/commands/dropbox/team/content/legacypaper/count.md —

dropbox team content legacypaper count

Count number of Paper documents per member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team content legacypaper count

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: stats

Paper count The command will generate a report in three different formats. stats.csv, stats.json, and stats.xlsx.

Column	Description
member_email	Member email address
created	Number of created Paper docs
accessed	Number of accessed Paper docs

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; stats_0000.xlsx, stats_0001.xlsx, stats_0002.xlsx, …

Title: dropbox team content legacypaper export URL: https://toolbox.watermint.org/commands/dropbox/team/content/legacypaper/export.md —

dropbox team content legacypaper export

Export entire team member Paper documents into local path

Usage

This document uses the Desktop folder for command example.

tbx dropbox team content legacypaper export -path /LOCAL/PATH/TO/EXPORT

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-filter-by`	Specify how the Paper docs should be filtered (doc_created/doc_accessed).	docs_created
`-format`	Export file format (html/markdown)	html
`-path`	Export folder path
`-peer`	Account alias	default

Results

Report: paper

Export data The command will generate a report in three different formats. paper.csv, paper.json, and paper.xlsx.

Column	Description
member_email	Member email address
paper_doc_id	Paper Document ID
paper_owner	Paper owner email address
paper_title	Paper title
paper_revision	Paper revision
export_path	Export file path

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; paper_0000.xlsx, paper_0001.xlsx, paper_0002.xlsx, …

Title: dropbox team content legacypaper list URL: https://toolbox.watermint.org/commands/dropbox/team/content/legacypaper/list.md —

dropbox team content legacypaper list

List team member Paper documents

Usage

This document uses the Desktop folder for command example.

tbx dropbox team content legacypaper list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-filter-by`	Specify how the Paper docs should be filtered (doc_created/doc_accessed).	docs_created
`-peer`	Account alias	default

Results

Report: paper

Member Paper metadata The command will generate a report in three different formats. paper.csv, paper.json, and paper.xlsx.

Column	Description
member_email	Member email address
paper_doc_id	Paper Document ID
paper_owner	Paper owner email address
paper_title	Paper title
paper_revision	Paper revision

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; paper_0000.xlsx, paper_0001.xlsx, paper_0002.xlsx, …

Title: dropbox team content member list URL: https://toolbox.watermint.org/commands/dropbox/team/content/member/list.md —

dropbox team content member list

List team folder & shared folder members

Usage

This document uses the Desktop folder for command example.

tbx dropbox team content member list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-folder-name`	Filter by folder name. Filter by exact match to the name.
`-folder-name-prefix`	Filter by folder name. Filter by name match to the prefix.
`-folder-name-suffix`	Filter by folder name. Filter by name match to the suffix.
`-member-type-external`	Filter folder members. Keep only members are external (not in the same team). Note: Invited members are marked as external member.
`-member-type-internal`	Filter folder members. Keep only members are internal (in the same team). Note: Invited members are marked as external member.
`-peer`	Account alias	default
`-scan-timeout`	Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like `TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME`.	short

Results

Report: membership

This report shows a list of shared folders and team folders with their members. If a folder has multiple members, then members are listed with rows. The command will generate a report in three different formats. membership.csv, membership.json, and membership.xlsx.

Column	Description
path	Path
folder_type	Type of the folder. (`team_folder`: a team folder or in a team folder, `shared_folder`: a shared folder)
owner_team_name	Team name of the team that owns the folder
access_type	User’s access level for this folder
member_type	Type of this member (user, group, or invitee)
member_name	Name of this member
member_email	Email address of this member
same_team	Whether the member is in the same team or not. Returns empty if the member is not able to determine whether in the same team or not.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; membership_0000.xlsx, membership_0001.xlsx, membership_0002.xlsx, …

Report: no_member

This report shows folders without members. The command will generate a report in three different formats. no_member.csv, no_member.json, and no_member.xlsx.

Column	Description
owner_team_name	Team name of the team that owns the folder
path	Path
folder_type	Type of the folder. (`team_folder`: a team folder or in a team folder, `shared_folder`: a shared folder)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; no_member_0000.xlsx, no_member_0001.xlsx, no_member_0002.xlsx, …

Title: dropbox team content member size URL: https://toolbox.watermint.org/commands/dropbox/team/content/member/size.md —

dropbox team content member size

Count number of members of team folders and shared folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox team content member size

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-folder-name`	Filter by folder name. Filter by exact match to the name.
`-folder-name-prefix`	Filter by folder name. Filter by name match to the prefix.
`-folder-name-suffix`	Filter by folder name. Filter by name match to the suffix.
`-include-sub-folders`	Include sub-folders to the report.	false
`-peer`	Account alias	default
`-scan-timeout`	Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like `TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME`.	short

Results

Report: member_count

Folder member count The command will generate a report in three different formats. member_count.csv, member_count.json, and member_count.xlsx.

Column	Description
path	Path
folder_type	Type of the folder. (`team_folder`: a team folder or in a team folder, `shared_folder`: a shared folder)
owner_team_name	Team name of the team that owns the folder
has_no_inherit	True if the folder or any sub-folder does not inherit the access permission from the parent folder
is_no_inherit	True if the folder does not inherit the access from the parent folder
capacity	Capacity number to add members. Empty if it’s not able to determine by your permission (e.g. a folder contains an external group).
count_total	Total number of members
count_external_groups	Number of external teams’ group

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_count_0000.xlsx, member_count_0001.xlsx, member_count_0002.xlsx, …

Title: dropbox team content mount list URL: https://toolbox.watermint.org/commands/dropbox/team/content/mount/list.md —

dropbox team content mount list

List all mounted/unmounted shared folders of team members.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team content mount list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-member-email`	Filter members. Filter by email address.
`-member-name`	Filter members. Filter by exact match to the name.
`-member-name-prefix`	Filter members. Filter by name match to the prefix.
`-member-name-suffix`	Filter members. Filter by name match to the suffix.
`-peer`	Account alias	default

Results

Report: mount

This report shows a list of shared folders. The command will generate a report in three different formats. mount.csv, mount.json, and mount.xlsx.

Column	Description
team_member_display_name	Team member display name.
team_member_email	Team member email address
namespace_id	Namespace Id
namespace_name	Name of the folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
mount_path	Mount path of this folder. The folder is not mounted if this field is empty.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mount_0000.xlsx, mount_0001.xlsx, mount_0002.xlsx, …

Title: dropbox team content policy list URL: https://toolbox.watermint.org/commands/dropbox/team/content/policy/list.md —

dropbox team content policy list

List policies of team folders and shared folders in the team

Usage

This document uses the Desktop folder for command example.

tbx dropbox team content policy list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-folder-name`	Filter by folder name. Filter by exact match to the name.
`-folder-name-prefix`	Filter by folder name. Filter by name match to the prefix.
`-folder-name-suffix`	Filter by folder name. Filter by name match to the suffix.
`-peer`	Account alias	default
`-scan-timeout`	Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like `TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME`.	short

Results

Report: policy

This report shows a list of shared folders and team folders with their current policy settings. The command will generate a report in three different formats. policy.csv, policy.json, and policy.xlsx.

Column	Description
path	Path
is_team_folder	`true` if the folder is a team folder, or inside of a team folder
owner_team_name	Team name of the team that owns the folder
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member	Who can be a member of this shared folder, taking into account both the folder and the team-wide policy.
policy_viewer_info	Who can enable/disable viewer info for this shared folder.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policy_0000.xlsx, policy_0001.xlsx, policy_0002.xlsx, …

Title: dropbox team device list URL: https://toolbox.watermint.org/commands/dropbox/team/device/list.md —

dropbox team device list

List all devices/sessions in the team

Usage

This document uses the Desktop folder for command example.

tbx dropbox team device list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: device

This report shows a list of current existing sessions in the team with team member information. The command will generate a report in three different formats. device.csv, device.json, and device.xlsx.

Column	Description
team_member_id	ID of user as a member of a team.
email	Email address of user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
given_name	Also known as a first name
surname	Also known as a last name or family name.
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
device_tag	Type of the session (web_session, desktop_client, or mobile_client)
id	The session id.
user_agent	Information on the hosting device.
os	Information on the hosting operating system
browser	Information on the browser used for this web session.
ip_address	The IP address of the last activity from this session.
country	The country from which the last activity from this session was made.
created	The time this session was created.
updated	The time of the last activity from this session.
expires	The time this session expires (optional)
host_name	Name of the hosting desktop.
client_type	The Dropbox desktop client type (windows, mac, or linux)
client_version	The Dropbox client version.
platform	Information on the hosting platform.
is_delete_on_unlink_supported	Whether it’s possible to delete all of the account files upon unlinking.
device_name	The device name.
os_version	The hosting OS version.
last_carrier	Last carrier used by the device (optional).

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; device_0000.xlsx, device_0001.xlsx, device_0002.xlsx, …

Title: dropbox team device unlink URL: https://toolbox.watermint.org/commands/dropbox/team/device/unlink.md —

dropbox team device unlink

Unlink device sessions (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team device unlink -file /path/to/data/file.csv

Options:

Option	Description	Default
`-delete-on-unlink`	Delete files on unlink	false
`-file`	Data file
`-peer`	Account alias	default

File formats

Format: File

This report shows a list of current existing sessions in the team with team member information.

Column	Description	Example
team_member_id	ID of user as a member of a team.	dbmid:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
email	Email address of user.	john.smith@example.com
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)	active
given_name	Also known as a first name	John
surname	Also known as a last name or family name.	Smith
familiar_name	Locale-dependent name	John Smith
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.	John Smith
abbreviated_name	An abbreviated form of the person’s name.	JS
external_id	External ID that a team can attach to the user (optional)	(empty string if not set)
account_id	A user’s account identifier.	dbid:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
device_tag	Type of the session (web_session, desktop_client, or mobile_client)	desktop_client
id	The session id.	dbdsid:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
user_agent	Information on the hosting device.	Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36
os	Information on the hosting operating system	Windows
browser	Information on the browser used for this web session.	Chrome
ip_address	The IP address of the last activity from this session.	xx.xxx.x.xxx
country	The country from which the last activity from this session was made.	United States
created	The time this session was created.	2019-09-20T23:47:33Z
updated	The time of the last activity from this session.	2019-10-25T04:42:16Z
expires	The time this session expires (optional)	2024-03-22T10:30:56Z
host_name	Name of the hosting desktop.	nihonbashi
client_type	The Dropbox desktop client type (windows, mac, or linux)	windows
client_version	The Dropbox client version.	83.4.152
platform	Information on the hosting platform.	Windows 10 1903
is_delete_on_unlink_supported	Whether it’s possible to delete all of the account files upon unlinking.	TRUE
device_name	The device name.	My Awesome PC
os_version	The hosting OS version.	(empty string if not set)
last_carrier	Last carrier used by the device (optional).	AT&T

The first line is a header line. The program will accept a file without the header.

team_member_id,email,status,given_name,surname,familiar_name,display_name,abbreviated_name,external_id,account_id,device_tag,id,user_agent,os,browser,ip_address,country,created,updated,expires,host_name,client_type,client_version,platform,is_delete_on_unlink_supported,device_name,os_version,last_carrier
dbmid:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx,john.smith@example.com,active,John,Smith,John Smith,John Smith,JS,(empty string if not set),dbid:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx,desktop_client,dbdsid:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx,"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",Windows,Chrome,xx.xxx.x.xxx,United States,2019-09-20T23:47:33Z,2019-10-25T04:42:16Z,2024-03-22T10:30:56Z,nihonbashi,windows,83.4.152,Windows 10 1903,TRUE,My Awesome PC,(empty string if not set),AT&T

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.team_member_id	ID of user as a member of a team.
input.email	Email address of user.
input.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
input.given_name	Also known as a first name
input.surname	Also known as a last name or family name.
input.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
input.device_tag	Type of the session (web_session, desktop_client, or mobile_client)
input.id	The session id.
input.user_agent	Information on the hosting device.
input.os	Information on the hosting operating system
input.browser	Information on the browser used for this web session.
input.ip_address	The IP address of the last activity from this session.
input.country	The country from which the last activity from this session was made.
input.created	The time this session was created.
input.updated	The time of the last activity from this session.
input.expires	The time this session expires (optional)
input.host_name	Name of the hosting desktop.
input.client_type	The Dropbox desktop client type (windows, mac, or linux)
input.client_version	The Dropbox client version.
input.platform	Information on the hosting platform.
input.is_delete_on_unlink_supported	Whether it’s possible to delete all of the account files upon unlinking.
input.device_name	The device name.
input.os_version	The hosting OS version.
input.last_carrier	Last carrier used by the device (optional).

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team filerequest list URL: https://toolbox.watermint.org/commands/dropbox/team/filerequest/list.md —

dropbox team filerequest list

List all file requests in the team

Usage

This document uses the Desktop folder for command example.

tbx dropbox team filerequest list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: file_request

This report shows a list of file requests with the file request owner team member. The command will generate a report in three different formats. file_request.csv, file_request.json, and file_request.xlsx.

Column	Description
email	Email address of this file request owner.
status	The user status of this file request owner (active/invited/suspended/removed)
surname	Surname of this file request owner.
given_name	Given name of this file request owner.
url	The URL of the file request.
title	The title of the file request.
created	When this file request was created.
is_open	Whether or not the file request is open.
file_count	The number of files this file request has received.
destination	The path of the folder in the Dropbox where uploaded files will be sent
deadline	The deadline for this file request.
deadline_allow_late_uploads	If set, allow uploads after the deadline has passed

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_request_0000.xlsx, file_request_0001.xlsx, file_request_0002.xlsx, …

Title: dropbox team group add URL: https://toolbox.watermint.org/commands/dropbox/team/group/add.md —

dropbox team group add

Create new group (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group add -name GROUP_NAME

Options:

Option	Description	Default
`-management-type`	Group management type `company_managed` or `user_managed`	company_managed
`-name`	Group name
`-peer`	Account alias	default

Results

Report: added_group

This report shows a list of groups in the team. The command will generate a report in three different formats. added_group.csv, added_group.json, and added_group.xlsx.

Column	Description
group_name	Name of a group
group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; added_group_0000.xlsx, added_group_0001.xlsx, added_group_0002.xlsx, …

Title: dropbox team group delete URL: https://toolbox.watermint.org/commands/dropbox/team/group/delete.md —

dropbox team group delete

Delete group (Irreversible operation)

This command does not confirm whether the group used in existing folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group delete -name GROUP_NAME

Options:

Option	Description	Default
`-name`	Group name
`-peer`	Account alias	default

Title: dropbox team group list URL: https://toolbox.watermint.org/commands/dropbox/team/group/list.md —

dropbox team group list

List group(s)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: group

This report shows a list of groups in the team. The command will generate a report in three different formats. group.csv, group.json, and group.xlsx.

Column	Description
group_name	Name of a group
group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; group_0000.xlsx, group_0001.xlsx, group_0002.xlsx, …

Title: dropbox team group rename URL: https://toolbox.watermint.org/commands/dropbox/team/group/rename.md —

dropbox team group rename

Rename the group (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group rename -current-name CURRENT_NAME -new-name NEW_NAME

Options:

Option	Description	Default
`-current-name`	Current group name
`-new-name`	New group name
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.current_name	Current group name
input.new_name	New group name
result.group_name	Name of a group
result.group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
result.member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group batch add URL: https://toolbox.watermint.org/commands/dropbox/team/group/batch/add.md —

dropbox team group batch add

Bulk adding groups

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group batch add -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-management-type`	Who is allowed to manage the group (user_managed, company_managed, or system_managed)	company_managed
`-peer`	Account alias	default

File formats

Format: File

Data file for batch operation to groups.

Column	Description	Example
name	Group name	Sales

The first line is a header line. The program will accept a file without the header.

name
Sales

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.name	Group name
result.group_name	Name of a group
result.group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
result.member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group batch delete URL: https://toolbox.watermint.org/commands/dropbox/team/group/batch/delete.md —

dropbox team group batch delete

Delete groups (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group batch delete -file /path/to/file.csv

Options:

Option	Description	Default
`-file`	Data file for group name list
`-peer`	Account alias	default

File formats

Format: File

Data file for batch operation to groups.

Column	Description	Example
name	Group name	Sales

The first line is a header line. The program will accept a file without the header.

name
Sales

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.name	Group name
result.group_name	Name of a group
result.group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
result.member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group clear externalid URL: https://toolbox.watermint.org/commands/dropbox/team/group/clear/externalid.md —

dropbox team group clear externalid

Clear an external ID of a group

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group clear externalid -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Group name

Column	Description	Example
name	Name of group to clear an external ID	Sales

The first line is a header line. The program will accept a file without the header.

name
Sales

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.name	Name of group to clear an external ID
result.group_name	Name of a group
result.group_id	Group ID
result.group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
result.group_external_id	External ID that a team can attach to the group.
result.member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group folder list URL: https://toolbox.watermint.org/commands/dropbox/team/group/folder/list.md —

dropbox team group folder list

List folders of each group

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group folder list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-folder-name`	Filter by folder name. Filter by exact match to the name.
`-folder-name-prefix`	Filter by folder name. Filter by name match to the prefix.
`-folder-name-suffix`	Filter by folder name. Filter by name match to the suffix.
`-group-name`	Filter by group name. Filter by exact match to the name.
`-group-name-prefix`	Filter by group name. Filter by name match to the prefix.
`-group-name-suffix`	Filter by group name. Filter by name match to the suffix.
`-include-external-groups`	Include external groups in the report.	false
`-peer`	Account alias	default
`-scan-timeout`	Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like `TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME`.	short

Results

Report: group_to_folder

Group to folder mapping. The command will generate a report in three different formats. group_to_folder.csv, group_to_folder.json, and group_to_folder.xlsx.

Column	Description
group_name	Name of a group
group_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
group_is_same_team	‘true’ if a group is in same team. Otherwise false.
access_type	Group’s access level for this folder
namespace_name	The name of this namespace
path	Path
folder_type	Type of the folder. (`team_folder`: a team folder or in a team folder, `shared_folder`: a shared folder)
owner_team_name	Team name of the team that owns the folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; group_to_folder_0000.xlsx, group_to_folder_0001.xlsx, group_to_folder_0002.xlsx, …

Report: group_with_no_folders

This report shows a list of groups in the team. The command will generate a report in three different formats. group_with_no_folders.csv, group_with_no_folders.json, and group_with_no_folders.xlsx.

Column	Description
group_name	Name of a group
group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; group_with_no_folders_0000.xlsx, group_with_no_folders_0001.xlsx, group_with_no_folders_0002.xlsx, …

Title: dropbox team group member add URL: https://toolbox.watermint.org/commands/dropbox/team/group/member/add.md —

dropbox team group member add

Add a member to the group (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group member add -group-name GROUP_NAME -member-email EMAIL

Options:

Option	Description	Default
`-group-name`	Group name
`-member-email`	Email address of the member
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.group_name	Name of the group
input.member_email	Email address of the member
result.group_name	Name of a group
result.group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
result.member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group member delete URL: https://toolbox.watermint.org/commands/dropbox/team/group/member/delete.md —

dropbox team group member delete

Delete a member from the group (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group member delete -group-name GROUP_NAME -member-email EMAIL

Options:

Option	Description	Default
`-group-name`	Name of the group
`-member-email`	Email address of the member
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.group_name	Name of the group
input.member_email	Email address of the member
result.group_name	Name of a group
result.group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
result.member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group member list URL: https://toolbox.watermint.org/commands/dropbox/team/group/member/list.md —

dropbox team group member list

List members of groups

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group member list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: group_member

This report shows a list of groups and their members. The command will generate a report in three different formats. group_member.csv, group_member.json, and group_member.xlsx.

Column	Description
group_name	Name of a group.
group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
access_type	The role that the user has in the group (member/owner)
email	Email address of user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
surname	Also known as a last name or family name.
given_name	Also known as a first name

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; group_member_0000.xlsx, group_member_0001.xlsx, group_member_0002.xlsx, …

Title: dropbox team group member batch add URL: https://toolbox.watermint.org/commands/dropbox/team/group/member/batch/add.md —

dropbox team group member batch add

Bulk add members into groups (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group member batch add -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Add members into groups

Column	Description	Example
group_name	Group name	Sales
member_email	Member email address	taro@example.com

The first line is a header line. The program will accept a file without the header.

group_name,member_email
Sales,taro@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.GroupName	Group name
input.MemberEmail	Member email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group member batch delete URL: https://toolbox.watermint.org/commands/dropbox/team/group/member/batch/delete.md —

dropbox team group member batch delete

Delete members from groups (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group member batch delete -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Add members into groups

Column	Description	Example
group_name	Group name	Sales
member_email	Member email address	taro@example.com

The first line is a header line. The program will accept a file without the header.

group_name,member_email
Sales,taro@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.GroupName	Group name
input.MemberEmail	Member email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group member batch update URL: https://toolbox.watermint.org/commands/dropbox/team/group/member/batch/update.md —

dropbox team group member batch update

Add or delete members from groups (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group member batch update -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Add members into groups

Column	Description	Example
group_name	Group name	Sales
member_email	Member email address	taro@example.com

The first line is a header line. The program will accept a file without the header.

group_name,member_email
Sales,taro@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.GroupName	Group name
input.MemberEmail	Member email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team group update type URL: https://toolbox.watermint.org/commands/dropbox/team/group/update/type.md —

dropbox team group update type

Update group management type

Usage

This document uses the Desktop folder for command example.

tbx dropbox team group update type -name GROUP_NAME

Options:

Option	Description	Default
`-name`	Group name
`-peer`	Account alias	default
`-type`	Group type (user_managed/company_managed)	company_managed

Results

Report: group

This report shows a list of groups in the team. The command will generate a report in three different formats. group.csv, group.json, and group.xlsx.

Column	Description
group_name	Name of a group
group_id	Group ID
group_management_type	Who is allowed to manage the group (user_managed, company_managed, or system_managed)
group_external_id	External ID that a team can attach to the group.
member_count	The number of members in the group.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; group_0000.xlsx, group_0001.xlsx, group_0002.xlsx, …

Title: dropbox team insight scan URL: https://toolbox.watermint.org/commands/dropbox/team/insight/scan.md —

dropbox team insight scan

Scans team data for analysis

This command collects various team data, such as files in team folders, permissions and shared links, and stores them in a database. The collected data can be analysed with commands such as dropbox team insight report teamfoldermember, or with database tools that support SQLite in general.

About how long a scan takes:.

Scanning a team often takes a long time. Especially if there are a large number of files stored, the time is linearly proportional to the number of files. To increase the scanning speed, it is better to use the -concurrency option for parallel processing. However, too much parallelism will increase the error rate from the Dropbox server, so a balance must be considered. According to the results of a few benchmarks, a parallelism level of 12-24 for the -concurrency option seems to be a good choice. The time required for scanning depends on the response of the Dropbox server, but is around 20-30 hours per 10 million files (with -concurrency 16).

During the scan, users might delete, move or add files during that time. The command does not aim to capture all those differences and report exact results, but to provide rough information as quickly as possible.

For database file sizes:.

As this command retrieves all metadata, including the team’s files, the size of the database increases with the size of those metadata. Benchmark results show that the database size is around 10-12 GB per 10 million files stored in the team. Make sure that the path specified by -database has enough space before running.

About scan errors:.

The Dropbox server may return an error when running the scan. The command will automatically try to re-run the scan several times, but the error may not be resolved for a certain period of time due to server congestion or condition. In that case, the command stops the re-run and records the scan task in the database where the error occurred. If you want to re-run a failed scan, use the dropbox team insight scanretry command to run the scan again. If the issue is not resolved after repeated re-runs and you want to analyse only the coverage of the current scan, you need to perform an aggregation task before the analysis. Aggregation tasks can be performed with the dropbox team insight summary command.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team insight scan -database /LOCAL/PATH/TO/database

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-database`	Path to database
`-max-retries`	Maximum number of retries	3
`-peer`	Account alias	default
`-scan-member-folders`	Scan member folders	false
`-skip-summarize`	Skip summarize tasks	false

Results

Report: errors

Error report The command will generate a report in three different formats. errors.csv, errors.json, and errors.xlsx.

Column	Description
category	Error category
message	Error message
tag	Error tag
detail	Error details

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; errors_0000.xlsx, errors_0001.xlsx, errors_0002.xlsx, …

Title: dropbox team insight report teamfoldermember URL: https://toolbox.watermint.org/commands/dropbox/team/insight/report/teamfoldermember.md —

dropbox team insight report teamfoldermember

Report team folder members

Usage

This document uses the Desktop folder for command example.

tbx dropbox team insight report teamfoldermember -database /LOCAL/PATH/TO/database

Options:

Option	Description	Default
`-database`	Path to database

Results

Report: entry

Team folder member The command will generate a report in three different formats. entry.csv, entry.json, and entry.xlsx.

Column	Description
team_folder_id	Team folder ID
team_folder_name	Team folder name
path_display	Display path
access_type	Access type
is_inherited	Inherited access
member_type	Member type
same_team	True if the member is in the same team
group_id	Group ID
group_name	Group name
group_type	Group management type
group_member_count	Group member count
invitee_email	Invitee email
user_team_member_id	User team member ID
user_email	User email
user_display_name	User display name
user_account_id	User account ID

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; entry_0000.xlsx, entry_0001.xlsx, entry_0002.xlsx, …

Title: dropbox team legalhold add URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/add.md —

dropbox team legalhold add

Creates new legal hold policy.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold add -member /PATH/TO/member_email.csv -name POLICY_NAME

Options:

Option	Description	Default
`-description`	A description of the legal hold policy.
`-end-date`	End date of the legal hold policy.
`-member`	email of the member or members you want to place a hold on
`-name`	Policy name.
`-peer`	Account alias	default
`-start-date`	Start date of the legal hold policy.

File formats

Format: Member

Member email address

Column	Description	Example
email	Team member email address	emma@example.com

The first line is a header line. The program will accept a file without the header.

email
emma@example.com

Results

Report: policy

Legal hold policy The command will generate a report in three different formats. policy.csv, policy.json, and policy.xlsx.

Column	Description
id	The legal hold id.
name	Policy name.
description	A description of the legal hold policy.
status	The current state of the hold.
start_date	Start date of the legal hold policy.
end_date	End date of the legal hold policy.
activation_time	The time at which the legal hold was activated.
permanently_deleted_users	Number of users permanently removed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policy_0000.xlsx, policy_0001.xlsx, policy_0002.xlsx, …

Title: dropbox team legalhold list URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/list.md —

dropbox team legalhold list

Retrieve existing policies

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold list

Options:

Option	Description	Default
`-include-released`	Whether to return holds that were released.	false
`-peer`	Account alias	default

Results

Report: policies

Legal hold policy The command will generate a report in three different formats. policies.csv, policies.json, and policies.xlsx.

Column	Description
id	The legal hold id.
name	Policy name.
description	A description of the legal hold policy.
status	The current state of the hold.
start_date	Start date of the legal hold policy.
end_date	End date of the legal hold policy.
activation_time	The time at which the legal hold was activated.
permanently_deleted_users	Number of users permanently removed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policies_0000.xlsx, policies_0001.xlsx, policies_0002.xlsx, …

Title: dropbox team legalhold release URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/release.md —

dropbox team legalhold release

Releases a legal hold by Id

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold release -policy-id POLICY_ID

Options:

Option	Description	Default
`-peer`	Account alias	default
`-policy-id`	Legal hold policy ID

Title: dropbox team legalhold member list URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/member/list.md —

dropbox team legalhold member list

List members of the legal hold

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold member list -policy-id POLICY_ID

Options:

Option	Description	Default
`-peer`	Account alias	default
`-policy-id`	Legal hold policy ID

Results

Report: member

This report shows a list of members. The command will generate a report in three different formats. member.csv, member.json, and member.xlsx.

Column	Description
team_member_id	ID of user as a member of a team.
email	Email address of user.
email_verified	Is true if the user’s email is verified to be owned by the user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
given_name	Also known as a first name
surname	Also known as a last name or family name.
familiar_name	Locale-dependent name
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
abbreviated_name	An abbreviated form of the person’s name.
member_folder_id	The namespace id of the user’s root folder.
external_id	External ID that a team can attach to the user.
account_id	A user’s account identifier.
persistent_id	Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
joined_on	The date and time the user joined as a member of a specific team.
invited_on	The date and time the user was invited to the team
role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_0000.xlsx, member_0001.xlsx, member_0002.xlsx, …

Title: dropbox team legalhold member batch update URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/member/batch/update.md —

dropbox team legalhold member batch update

Update member list of legal hold policy

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold member batch update -member /PATH/TO/MEMBER_LIST.csv -policy-id POLICY_ID

Options:

Option	Description	Default
`-member`	Path to member list file
`-peer`	Account alias	default
`-policy-id`	Legal hold policy ID

File formats

Format: Member

Member email address

Column	Description	Example
email	Email address	emma@example.com

The first line is a header line. The program will accept a file without the header.

email
emma@example.com

Results

Report: policy

This report shows a list of members. The command will generate a report in three different formats. policy.csv, policy.json, and policy.xlsx.

Column	Description
team_member_id	ID of user as a member of a team.
email	Email address of user.
email_verified	Is true if the user’s email is verified to be owned by the user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
given_name	Also known as a first name
surname	Also known as a last name or family name.
familiar_name	Locale-dependent name
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
abbreviated_name	An abbreviated form of the person’s name.
member_folder_id	The namespace id of the user’s root folder.
external_id	External ID that a team can attach to the user.
account_id	A user’s account identifier.
persistent_id	Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
joined_on	The date and time the user joined as a member of a specific team.
invited_on	The date and time the user was invited to the team
role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policy_0000.xlsx, policy_0001.xlsx, policy_0002.xlsx, …

Title: dropbox team legalhold revision list URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/revision/list.md —

dropbox team legalhold revision list

List revisions under legal hold

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold revision list -after DATE_TIME -policy-id POLICY_ID

Options:

Option	Description	Default
`-after`	Get revisions after this specified date and time
`-peer`	Account alias	default
`-policy-id`	Legal hold policy ID.

Results

Report: revision

Revision The command will generate a report in three different formats. revision.csv, revision.json, and revision.xlsx.

| Column | Description | |——–|————-|

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; revision_0000.xlsx, revision_0001.xlsx, revision_0002.xlsx, …

Title: dropbox team legalhold update desc URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/update/desc.md —

dropbox team legalhold update desc

Update description of the legal hold policy

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold update desc -desc DESCRIPTION -policy-id POLICY_ID

Options:

Option	Description	Default
`-desc`	New description
`-peer`	Account alias	default
`-policy-id`	Legal hold policy ID

Results

Report: policy

Legal hold policy The command will generate a report in three different formats. policy.csv, policy.json, and policy.xlsx.

Column	Description
id	The legal hold id.
name	Policy name.
description	A description of the legal hold policy.
status	The current state of the hold.
start_date	Start date of the legal hold policy.
end_date	End date of the legal hold policy.
activation_time	The time at which the legal hold was activated.
permanently_deleted_users	Number of users permanently removed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policy_0000.xlsx, policy_0001.xlsx, policy_0002.xlsx, …

Title: dropbox team legalhold update name URL: https://toolbox.watermint.org/commands/dropbox/team/legalhold/update/name.md —

dropbox team legalhold update name

Update name of the legal hold policy

Usage

This document uses the Desktop folder for command example.

tbx dropbox team legalhold update name -name NEW_NAME -policy-id POLICY_ID

Options:

Option	Description	Default
`-name`	New name
`-peer`	Account alias	default
`-policy-id`	Legal hold policy ID

Results

Report: policy

Legal hold policy The command will generate a report in three different formats. policy.csv, policy.json, and policy.xlsx.

Column	Description
id	The legal hold id.
name	Policy name.
description	A description of the legal hold policy.
status	The current state of the hold.
start_date	Start date of the legal hold policy.
end_date	End date of the legal hold policy.
activation_time	The time at which the legal hold was activated.
permanently_deleted_users	Number of users permanently removed.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policy_0000.xlsx, policy_0001.xlsx, policy_0002.xlsx, …

Title: dropbox team linkedapp list URL: https://toolbox.watermint.org/commands/dropbox/team/linkedapp/list.md —

dropbox team linkedapp list

List linked applications

Usage

This document uses the Desktop folder for command example.

tbx dropbox team linkedapp list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: linked_app

This report shows a list of linked app with the user of the app. The command will generate a report in three different formats. linked_app.csv, linked_app.json, and linked_app.xlsx.

Column	Description
email	Email address of user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
given_name	Also known as a first name
surname	Also known as a last name or family name.
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
app_name	The application name.
is_app_folder	Whether the linked application uses a dedicated folder.
publisher	The publisher’s URL.
publisher_url	The application publisher name.
linked	The time this application was linked

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; linked_app_0000.xlsx, linked_app_0001.xlsx, linked_app_0002.xlsx, …

Title: dropbox team member feature URL: https://toolbox.watermint.org/commands/dropbox/team/member/feature.md —

dropbox team member feature

List member feature settings

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member feature

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: features

Member features The command will generate a report in three different formats. features.csv, features.json, and features.xlsx.

Column	Description
email	Email address of the team member
paper_as_files	When this value is true, the user’s Paper docs are accessible in Dropbox with the .paper extension and must be accessed via the /files endpoints.
file_locking	When this value is True, the user can lock files in shared folders.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; features_0000.xlsx, features_0001.xlsx, features_0002.xlsx, …

Title: dropbox team member list URL: https://toolbox.watermint.org/commands/dropbox/team/member/list.md —

dropbox team member list

List team member(s)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member list

Options:

Option	Description	Default
`-include-deleted`	Include deleted members.	false
`-peer`	Account alias	default

Results

Report: member

This report shows a list of members. The command will generate a report in three different formats. member.csv, member.json, and member.xlsx.

Column	Description
email	Email address of user.
email_verified	Is true if the user’s email is verified to be owned by the user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
given_name	Also known as a first name
surname	Also known as a last name or family name.
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
joined_on	The date and time the user joined as a member of a specific team.
invited_on	The date and time the user was invited to the team
role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_0000.xlsx, member_0001.xlsx, member_0002.xlsx, …

Title: dropbox team member replication URL: https://toolbox.watermint.org/commands/dropbox/team/member/replication.md —

dropbox team member replication

Replicate team member files (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member replication -file /path/to/file.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dst`	Destination team; team file access	dst
`-file`	Data file
`-src`	Source team; team file access	src

File formats

Format: File

Data file for replicating member contents.

Column	Description	Example
src_email	Source account’s email address	john@example.net
dst_email	Destination account’s email address	john.smith@example.com

The first line is a header line. The program will accept a file without the header.

src_email,dst_email
john@example.net,john.smith@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.src_email	Source account’s email address
input.dst_email	Destination account’s email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member suspend URL: https://toolbox.watermint.org/commands/dropbox/team/member/suspend.md —

dropbox team member suspend

Suspend a member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member suspend -email EMAIL

Options:

Option	Description	Default
`-email`	Member’s email address
`-keep-data`	Keep the user’s data on their linked devices	false
`-peer`	Account alias	default

Title: dropbox team member unsuspend URL: https://toolbox.watermint.org/commands/dropbox/team/member/unsuspend.md —

dropbox team member unsuspend

Unsuspend a member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member unsuspend -email EMAIL

Options:

Option	Description	Default
`-email`	Member’s email address
`-peer`	Account alias	default

Title: dropbox team member batch delete URL: https://toolbox.watermint.org/commands/dropbox/team/member/batch/delete.md —

dropbox team member batch delete

Delete members (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member batch delete -file /PATH/TO/member_list.csv

Options:

Option	Description	Default
`-file`	Data file
`-peer`	Account alias	default
`-transfer-dest-member`	If provided, files from the deleted member account will be transferred to this user.
`-transfer-notify-admin-email-on-error`	If provided, errors during the transfer process will be sent via email to this user.
`-wipe-data`	If true, controls if the user’s data will be deleted on their linked devices	true

File formats

Format: File

Data file for deleting team members.

Column	Description	Example
email	Email address of the account	john@example.com

The first line is a header line. The program will accept a file without the header.

email
john@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of the account

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member batch detach URL: https://toolbox.watermint.org/commands/dropbox/team/member/batch/detach.md —

dropbox team member batch detach

Convert Dropbox for teams accounts to a Basic account (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member batch detach -file /PATH/TO/member_list.csv

Options:

Option	Description	Default
`-file`	Data file
`-peer`	Account alias	default
`-revoke-team-shares`	True for revoke shared folder access which owned by the team	false

File formats

Format: File

Data file for converting team members into Dropbox Basic account.

Column	Description	Example
email	Email address of the account	john@example.com

The first line is a header line. The program will accept a file without the header.

email
john@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of the account

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member batch invite URL: https://toolbox.watermint.org/commands/dropbox/team/member/batch/invite.md —

dropbox team member batch invite

Invite member(s) (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member batch invite -file /PATH/TO/member_list.csv

Options:

Option	Description	Default
`-file`	Data file
`-peer`	Account alias	default
`-silent-invite`	Do not send welcome email (requires SSO + domain verification instead)	false

File formats

Format: File

Data file for invite team members.

Column	Description	Example
email	Email address of the account	john@example.com
given_name	Given name of the account	John
surname	Surname of the account	Smith

The first line is a header line. The program will accept a file without the header.

email,given_name,surname
john@example.com,John,Smith

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of the account
input.given_name	Given name of the account
input.surname	Surname of the account
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member batch reinvite URL: https://toolbox.watermint.org/commands/dropbox/team/member/batch/reinvite.md —

dropbox team member batch reinvite

Reinvite invited status members to the team (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member batch reinvite

Options:

Option	Description	Default
`-peer`	Account alias	default
`-silent`	Do not send welcome email (SSO required)	false

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of user.
input.email_verified	Is true if the user’s email is verified to be owned by the user.
input.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
input.given_name	Also known as a first name
input.surname	Also known as a last name or family name.
input.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
input.joined_on	The date and time the user joined as a member of a specific team.
input.invited_on	The date and time the user was invited to the team
input.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
input.tag	Operation tag
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member batch suspend URL: https://toolbox.watermint.org/commands/dropbox/team/member/batch/suspend.md —

dropbox team member batch suspend

Bulk suspend members

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member batch suspend -file /PATH/TO/member_list.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-keep-data`	Keep the user’s data on their linked devices	false
`-peer`	Account alias	default

File formats

Format: File

User selector data

Column	Description	Example
email	Member’s email address	john@example.com

The first line is a header line. The program will accept a file without the header.

email
john@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Member’s email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member batch unsuspend URL: https://toolbox.watermint.org/commands/dropbox/team/member/batch/unsuspend.md —

dropbox team member batch unsuspend

Bulk unsuspend members

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member batch unsuspend -file /PATH/TO/member_list.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

User selector data

Column	Description	Example
email	Member’s email address	john@example.com

The first line is a header line. The program will accept a file without the header.

email
john@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Member’s email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member clear externalid URL: https://toolbox.watermint.org/commands/dropbox/team/member/clear/externalid.md —

dropbox team member clear externalid

Clear external_id of members

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member clear externalid -file /PATH/TO/member_list.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Email addresses of team members

Column	Description	Example
email	Email address of the member	john@example.com

The first line is a header line. The program will accept a file without the header.

email
john@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of the member
result.team_member_id	ID of user as a member of a team.
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.familiar_name	Locale-dependent name
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.abbreviated_name	An abbreviated form of the person’s name.
result.member_folder_id	The namespace id of the user’s root folder.
result.external_id	External ID that a team can attach to the user.
result.account_id	A user’s account identifier.
result.persistent_id	Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member file permdelete URL: https://toolbox.watermint.org/commands/dropbox/team/member/file/permdelete.md —

dropbox team member file permdelete

Permanently delete the file or folder at a given path of the team member. (Experimental, and Irreversible operation)

Please see https://www.dropbox.com/help/40 for more detail about permanent deletion.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member file permdelete -member-email EMAIL -path /DROPBOX/PATH/TO/DELETE

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-member-email`	Team member email address
`-path`	Path to delete
`-peer`	Account alias	default

Title: dropbox team member file lock list URL: https://toolbox.watermint.org/commands/dropbox/team/member/file/lock/list.md —

dropbox team member file lock list

List locks of the member under the path

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member file lock list -member-email EMAIL -path /DROPBOX/PATH/TO/LIST_LOCK

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-member-email`	Member email address
`-path`	Path
`-peer`	Account alias	default

Results

Report: lock

Lock information The command will generate a report in three different formats. lock.csv, lock.json, and lock.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.
is_lock_holder	True if caller holds the file lock
lock_holder_name	The display name of the lock holder.
lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; lock_0000.xlsx, lock_0001.xlsx, lock_0002.xlsx, …

Title: dropbox team member file lock release URL: https://toolbox.watermint.org/commands/dropbox/team/member/file/lock/release.md —

dropbox team member file lock release

Release the lock of the path as the member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member file lock release -member-email VALUE -path /DROPBOX/PATH/TO/RELEASE/LOCK

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-member-email`	Member email address
`-path`	Path to release lock
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member file lock all release URL: https://toolbox.watermint.org/commands/dropbox/team/member/file/lock/all/release.md —

dropbox team member file lock all release

Release all locks under the path of the member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member file lock all release -member-email VALUE -path /DROPBOX/PATH/TO/RELEASE/LOCK

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-batch-size`	Batch operation size	100
`-member-email`	Member email address
`-path`	Path to release lock
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member folder list URL: https://toolbox.watermint.org/commands/dropbox/team/member/folder/list.md —

dropbox team member folder list

List folders for each member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member folder list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-folder-name`	Filter by folder name. Filter by exact match to the name.
`-folder-name-prefix`	Filter by folder name. Filter by name match to the prefix.
`-folder-name-suffix`	Filter by folder name. Filter by name match to the suffix.
`-member-email`	Filter by member email address. Filter by email address.
`-peer`	Account alias	default
`-scan-timeout`	Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like `TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME`.	short

Results

Report: member_to_folder

Member to folder mapping. The command will generate a report in three different formats. member_to_folder.csv, member_to_folder.json, and member_to_folder.xlsx.

Column	Description
member_name	Team member display name.
member_email	Email address of the member
access_type	User’s access level for this folder
namespace_name	The name of this namespace
path	Path
folder_type	Type of the folder. (`team_folder`: a team folder or in a team folder, `shared_folder`: a shared folder)
owner_team_name	Team name of the team that owns the folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_to_folder_0000.xlsx, member_to_folder_0001.xlsx, member_to_folder_0002.xlsx, …

Report: member_with_no_folder

This report shows a list of members. The command will generate a report in three different formats. member_with_no_folder.csv, member_with_no_folder.json, and member_with_no_folder.xlsx.

Column	Description
email	Email address of user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
given_name	Also known as a first name
surname	Also known as a last name or family name.
display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
invited_on	The date and time the user was invited to the team

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_with_no_folder_0000.xlsx, member_with_no_folder_0001.xlsx, member_with_no_folder_0002.xlsx, …

Title: dropbox team member folder replication URL: https://toolbox.watermint.org/commands/dropbox/team/member/folder/replication.md —

dropbox team member folder replication

Replicate a folder to another member’s personal folder (Irreversible operation)

This command will replicate files under the source folder to the destination folder. The source folder can be a source member’s personal folder, a shared folder, or a team folder. But that must be mounted and accessible. This command will overwrite a file if the file already exists on the destination path. This command is the one-way copy from source path in a source member, to destination path in destination member. That means the command will not delete the file on the destination path, which deleted on the source path.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member folder replication -dst-path /DROPBOX/PATH/OF/DST -src-path /DROPBOX/PATH/OF/SRC -dst-member-email DST_MEMBER@email.address -src-member-email SRC_MEMBER@email.address

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-dst-member-email`	Destination team member email address
`-dst-path`	The path for the destination team member. Note the root (/) path is not allowed. You should choose any folder under the root.
`-peer`	Account alias	default
`-src-member-email`	Source team member email address
`-src-path`	The path of the source team member

Title: dropbox team member quota list URL: https://toolbox.watermint.org/commands/dropbox/team/member/quota/list.md —

dropbox team member quota list

List team member quota

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member quota list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: member_quota

This report shows a list of custom quota settings for each team members. The command will generate a report in three different formats. member_quota.csv, member_quota.json, and member_quota.xlsx.

Column	Description
email	Email address of user.
quota	Custom quota in GB (1 TB = 1024 GB). 0 if the user has no custom quota set.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_quota_0000.xlsx, member_quota_0001.xlsx, member_quota_0002.xlsx, …

Title: dropbox team member quota usage URL: https://toolbox.watermint.org/commands/dropbox/team/member/quota/usage.md —

dropbox team member quota usage

List team member storage usage

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member quota usage

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default

Results

Report: usage

This report shows current storage usage of users. The command will generate a report in three different formats. usage.csv, usage.json, and usage.xlsx.

Column	Description
email	Email address of the account
used_gb	The user’s total space usage (in GB, 1GB = 1024 MB).
used_bytes	The user’s total space usage (bytes).
allocation	The user’s space allocation (individual, or team)
allocated	The total space allocated to the user’s account (bytes).

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; usage_0000.xlsx, usage_0001.xlsx, usage_0002.xlsx, …

Title: dropbox team member quota batch update URL: https://toolbox.watermint.org/commands/dropbox/team/member/quota/batch/update.md —

dropbox team member quota batch update

Update team member quota

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member quota batch update -file /path/to/file.csv

Options:

Option	Description	Default
`-file`	Data file
`-peer`	Account alias	default
`-quota`	Custom quota in GB (1TB = 1024GB). 0 if the user has no custom quota set.	0

File formats

Format: File

This report shows a list of custom quota settings for each team members.

Column	Description	Example
email	Email address of user.	john@example.com
quota	Custom quota in GB (1 TB = 1024 GB). 0 if the user has no custom quota set.	50

The first line is a header line. The program will accept a file without the header.

email,quota
john@example.com,50

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of user.
input.quota	Custom quota in GB (1 TB = 1024 GB). 0 if the user has no custom quota set.
result.email	Email address of user.
result.quota	Custom quota in GB (1 TB = 1024 GB). 0 if the user has no custom quota set.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member update batch email URL: https://toolbox.watermint.org/commands/dropbox/team/member/update/batch/email.md —

dropbox team member update batch email

Member email operation (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member update batch email -file /path/to/data/file.csv

Options:

Option	Description	Default
`-file`	Data file
`-peer`	Account alias	default
`-update-unverified`	Update an account which didn’t verified email. If an account email unverified, email address change may affect lose invitation to folders.	false

File formats

Format: File

Data file for updating team member email addresses.

Column	Description	Example
from_email	Current Email address	john@example.com
to_email	New Email address	john.smith@example.net

The first line is a header line. The program will accept a file without the header.

from_email,to_email
john@example.com,john.smith@example.net

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.from_email	Current Email address
input.to_email	New Email address
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member update batch externalid URL: https://toolbox.watermint.org/commands/dropbox/team/member/update/batch/externalid.md —

dropbox team member update batch externalid

Update External ID of team members (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member update batch externalid -file /path/to/file.csv

Options:

Option	Description	Default
`-file`	Data file
`-peer`	Account alias	default

File formats

Format: File

Data file for updating member external id.

Column	Description	Example
email	Email address of team members	john@example.com
external_id	External ID of team members	0123456789

The first line is a header line. The program will accept a file without the header.

email,external_id
john@example.com,0123456789

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of team members
input.external_id	External ID of team members
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member update batch invisible URL: https://toolbox.watermint.org/commands/dropbox/team/member/update/batch/invisible.md —

dropbox team member update batch invisible

Enable directory restriction to members (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member update batch invisible -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Member list for changing visibility

Column	Description	Example
email	Member email address	taro@example.com

The first line is a header line. The program will accept a file without the header.

email
taro@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.Email	Member email address
result.team_member_id	ID of user as a member of a team.
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.familiar_name	Locale-dependent name
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.abbreviated_name	An abbreviated form of the person’s name.
result.member_folder_id	The namespace id of the user’s root folder.
result.external_id	External ID that a team can attach to the user.
result.account_id	A user’s account identifier.
result.persistent_id	Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member update batch profile URL: https://toolbox.watermint.org/commands/dropbox/team/member/update/batch/profile.md —

dropbox team member update batch profile

Batch update member profiles (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member update batch profile -file /path/to/data/file.csv

Options:

Option	Description	Default
`-file`	Data file
`-peer`	Account alias	default

File formats

Format: File

Data file for batch profile updates.

Column	Description	Example
email	Email address of the account	john@example.com
given_name	Given name of the account	John
surname	Surname of the account	Smith

The first line is a header line. The program will accept a file without the header.

email,given_name,surname
john@example.com,John,Smith

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.email	Email address of the account
input.given_name	Given name of the account
input.surname	Surname of the account
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team member update batch visible URL: https://toolbox.watermint.org/commands/dropbox/team/member/update/batch/visible.md —

dropbox team member update batch visible

Disable directory restriction to members (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team member update batch visible -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Member list for changing visibility

Column	Description	Example
email	Member email address	taro@example.com

The first line is a header line. The program will accept a file without the header.

email
taro@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.Email	Member email address
result.team_member_id	ID of user as a member of a team.
result.email	Email address of user.
result.email_verified	Is true if the user’s email is verified to be owned by the user.
result.status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
result.given_name	Also known as a first name
result.surname	Also known as a last name or family name.
result.familiar_name	Locale-dependent name
result.display_name	A name that can be used directly to represent the name of a user’s Dropbox account.
result.abbreviated_name	An abbreviated form of the person’s name.
result.member_folder_id	The namespace id of the user’s root folder.
result.external_id	External ID that a team can attach to the user.
result.account_id	A user’s account identifier.
result.persistent_id	Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
result.joined_on	The date and time the user joined as a member of a specific team.
result.invited_on	The date and time the user was invited to the team
result.role	The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only)
result.tag	Operation tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team namespace list URL: https://toolbox.watermint.org/commands/dropbox/team/namespace/list.md —

dropbox team namespace list

List all namespaces of the team

Usage

This document uses the Desktop folder for command example.

tbx dropbox team namespace list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: namespace

This report shows a list of namespaces in the team. The command will generate a report in three different formats. namespace.csv, namespace.json, and namespace.xlsx.

Column	Description
name	The name of this namespace
namespace_type	The type of this namespace (app_folder, shared_folder, team_folder, or team_member_folder)
team_member_id	If this is a team member or app folder, the ID of the owning team member.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; namespace_0000.xlsx, namespace_0001.xlsx, namespace_0002.xlsx, …

Title: dropbox team namespace summary URL: https://toolbox.watermint.org/commands/dropbox/team/namespace/summary.md —

dropbox team namespace summary

Report team namespace status summary.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team namespace summary

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default
`-skip-member-summary`	Skip scanning member namespaces	false

Results

Report: folder_without_parent

Folders without parent folder. The command will generate a report in three different formats. folder_without_parent.csv, folder_without_parent.json, and folder_without_parent.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
parent_shared_folder_id	The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_id	Team ID of the folder owner team
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; folder_without_parent_0000.xlsx, folder_without_parent_0001.xlsx, folder_without_parent_0002.xlsx, …

Report: member

Member namespace summary The command will generate a report in three different formats. member.csv, member.json, and member.xlsx.

Column	Description
email	Member email address
total_namespaces	Number of total namespaces (excluding member root namespace)
mounted_namespaces	Number of mounted folders
owner_namespaces	Number of shared folders owned by this member
team_folders	Number of team folders
inside_team_folders	Number of folders inside team folders
external_folders	Number of folders shared by a user outside the team
app_folders	Number of app folders

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; member_0000.xlsx, member_0001.xlsx, member_0002.xlsx, …

Report: team

Team namespace summary. The command will generate a report in three different formats. team.csv, team.json, and team.xlsx.

Column	Description
namespace_type	Type of namespace
namespace_count	Number of namespaces

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; team_0000.xlsx, team_0001.xlsx, team_0002.xlsx, …

Report: team_folder

Team folder summary. The command will generate a report in three different formats. team_folder.csv, team_folder.json, and team_folder.xlsx.

Column	Description
name	Team folder name
num_namespaces_inside	Number of namespaces inside this team folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; team_folder_0000.xlsx, team_folder_0001.xlsx, team_folder_0002.xlsx, …

Title: dropbox team namespace file list URL: https://toolbox.watermint.org/commands/dropbox/team/namespace/file/list.md —

dropbox team namespace file list

List all files and folders of the team namespaces

Usage

This document uses the Desktop folder for command example.

tbx dropbox team namespace file list

Options:

Option	Description	Default
`-folder-name`	List only for the folder matched to the name. Filter by exact match to the name.
`-folder-name-prefix`	List only for the folder matched to the name. Filter by name match to the prefix.
`-folder-name-suffix`	List only for the folder matched to the name. Filter by name match to the suffix.
`-include-deleted`	If true, deleted file or folder will be returned	false
`-include-member-folder`	If true, include team member folders	false
`-include-shared-folder`	If true, include shared folders	true
`-include-team-folder`	If true, include team folders	true
`-peer`	Account alias	default

Results

Report: errors

This report shows the transaction result. The command will generate a report in three different formats. errors.csv, errors.json, and errors.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.namespace	Namespace
input.path	Path

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; errors_0000.xlsx, errors_0001.xlsx, errors_0002.xlsx, …

Report: namespace_file

This report shows a list of namespaces in the team. The command will generate a report in three different formats. namespace_file.csv, namespace_file.json, and namespace_file.xlsx.

Column	Description
namespace_type	The type of this namespace (app_folder, shared_folder, team_folder, or team_member_folder)
namespace_name	The name of this namespace
namespace_member_email	If this is a team member or app folder, the email address of the owning team member.
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; namespace_file_0000.xlsx, namespace_file_0001.xlsx, namespace_file_0002.xlsx, …

Title: dropbox team namespace file size URL: https://toolbox.watermint.org/commands/dropbox/team/namespace/file/size.md —

dropbox team namespace file size

List all files and folders of the team namespaces

Usage

This document uses the Desktop folder for command example.

tbx dropbox team namespace file size

Options:

Option	Description	Default
`-depth`	Report entry for all files and directories depth directories deep	3
`-folder-name`	List only for the folder matched to the name. Filter by exact match to the name.
`-folder-name-prefix`	List only for the folder matched to the name. Filter by name match to the prefix.
`-folder-name-suffix`	List only for the folder matched to the name. Filter by name match to the suffix.
`-include-app-folder`	If true, include app folders	false
`-include-member-folder`	if true, include team member folders	false
`-include-shared-folder`	If true, include shared folders	true
`-include-team-folder`	If true, include team folders	true
`-peer`	Account alias	default

Results

Report: namespace_size

Namespace size in bytes The command will generate a report in three different formats. namespace_size.csv, namespace_size.json, and namespace_size.xlsx.

Column	Description
namespace_name	The name of this namespace
namespace_id	The ID of this namespace.
namespace_type	The type of this namespace (app_folder, shared_folder, team_folder, or team_member_folder)
owner_team_member_id	If this is a team member or app folder, the ID of the owning team member.
path	Path to the folder
count_file	Number of files under the folder
count_folder	Number of folders under the folder
count_descendant	Number of files and folders under the folder
size	Size of the folder
depth	Namespace depth
mod_time_earliest	Earliest modification time in namespace
mod_time_latest	Latest modification time in namespace
api_complexity	Folder complexity index for API operations

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; namespace_size_0000.xlsx, namespace_size_0001.xlsx, namespace_size_0002.xlsx, …

Title: dropbox team namespace member list URL: https://toolbox.watermint.org/commands/dropbox/team/namespace/member/list.md —

dropbox team namespace member list

List members of shared folders and team folders in the team

Usage

This document uses the Desktop folder for command example.

tbx dropbox team namespace member list

Options:

Option	Description	Default
`-all-columns`	Show all columns	false
`-peer`	Account alias	default

Results

Report: namespace_member

This report shows a list of members of namespaces in the team. The command will generate a report in three different formats. namespace_member.csv, namespace_member.json, and namespace_member.xlsx.

Column	Description
namespace_name	The name of this namespace
namespace_type	The type of this namespace (app_folder, shared_folder, team_folder, or team_member_folder)
entry_access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
entry_is_inherited	True if the member has access from a parent folder
email	Email address of user.
display_name	Team member display name.
group_name	Name of the group
invitee_email	Email address of invitee for this folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; namespace_member_0000.xlsx, namespace_member_0001.xlsx, namespace_member_0002.xlsx, …

Title: dropbox team runas file list URL: https://toolbox.watermint.org/commands/dropbox/team/runas/file/list.md —

dropbox team runas file list

List files and folders run as a member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas file list -member-email MEMBER@DOMAIN -path /DROPBOX/PATH/TO/LIST

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-include-deleted`	Include deleted files	false
`-include-explicit-shared-members`	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.	false
`-include-mounted-folders`	If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.	false
`-member-email`	Email address of the member
`-path`	Path
`-peer`	Account alias	default
`-recursive`	List recursively	false

Results

Report: file_list

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. file_list.csv, file_list.json, and file_list.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; file_list_0000.xlsx, file_list_0001.xlsx, file_list_0002.xlsx, …

Title: dropbox team runas file batch copy URL: https://toolbox.watermint.org/commands/dropbox/team/runas/file/batch/copy.md —

dropbox team runas file batch copy

Batch copy files/folders as a member (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas file batch copy -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Mapping between source and destination paths

Column	Description	Example
member_email	Team member email address	emma@example.com
src_path	Source path	/report
dst_path	Destination path	/backup/report

The first line is a header line. The program will accept a file without the header.

member_email,src_path,dst_path
emma@example.com,/report,/backup/report

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.member_email	Team member email address
input.src_path	Source path
input.dst_path	Destination path

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team runas file sync batch up URL: https://toolbox.watermint.org/commands/dropbox/team/runas/file/sync/batch/up.md —

dropbox team runas file sync batch up

Batch upstream sync with Dropbox (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas file sync batch up -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-batch-size`	Batch commit size	250
`-delete`	Delete Dropbox file if a file removed locally	false
`-exit-on-failure`	Exit the program on failure	false
`-file`	Path to data file
`-name-disable-ignore`	Name for the sync batch operation. Filter system file or ignore files.
`-name-name`	Name for the sync batch operation. Filter by exact match to the name.
`-name-name-prefix`	Name for the sync batch operation. Filter by name match to the prefix.
`-name-name-suffix`	Name for the sync batch operation. Filter by name match to the suffix.
`-overwrite`	Overwrite existing files if they exist.	false
`-peer`	Account alias	default

File formats

Format: File

Mapping of local files to Dropbox paths for batch upload.

Column	Description	Example
member_email	Email address of the Dropbox team member.	user@example.com
local_path	Local file path to upload.	/Users/alice/Documents/file.txt
dropbox_path	Destination path in Dropbox.	/Team Folder/Project/file.txt

The first line is a header line. The program will accept a file without the header.

member_email,local_path,dropbox_path
user@example.com,/Users/alice/Documents/file.txt,/Team Folder/Project/file.txt

Results

Report: deleted

Path The command will generate a report in three different formats. deleted.csv, deleted.json, and deleted.xlsx.

Column	Description
entry_path	Path
entry_shard.file_system_type	File system type
entry_shard.shard_id	Shard ID
entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; deleted_0000.xlsx, deleted_0001.xlsx, deleted_0002.xlsx, …

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.member_email	Email address of the Dropbox team member.
input.local_path	Local file path to upload.
input.dropbox_path	Destination path in Dropbox.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Report: skipped

This report shows the transaction result. The command will generate a report in three different formats. skipped.csv, skipped.json, and skipped.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.entry_path	Path
input.entry_shard.file_system_type	File system type
input.entry_shard.shard_id	Shard ID
input.entry_shard.attributes	Shard attributes

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; skipped_0000.xlsx, skipped_0001.xlsx, skipped_0002.xlsx, …

Report: summary

This report shows a summary of the upload results. The command will generate a report in three different formats. summary.csv, summary.json, and summary.xlsx.

Column	Description
start	Time of start
end	Time of finish
num_bytes	Total upload size (Bytes)
num_files_error	The number of files failed or got an error.
num_files_transferred	The number of files uploaded/downloaded.
num_files_skip	The number of files skipped or to skip.
num_folder_created	Number of created folders.
num_delete	Number of deleted entry.
num_api_call	The number of estimated upload API call for upload.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; summary_0000.xlsx, summary_0001.xlsx, summary_0002.xlsx, …

Report: uploaded

This report shows the transaction result. The command will generate a report in three different formats. uploaded.csv, uploaded.json, and uploaded.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.name	The last component of the path (including extension).
result.path_display	The cased path to be used for display purposes only.
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.content_hash	A hash of the file content.
result.has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; uploaded_0000.xlsx, uploaded_0001.xlsx, uploaded_0002.xlsx, …

Title: dropbox team runas sharedfolder isolate URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/isolate.md —

dropbox team runas sharedfolder isolate

Isolate member from shared folder (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder isolate -member-email EMAIL

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to isolate.	root
`-keep-copy`	Keep a copy after isolation.	false
`-member-email`	Email address of the member to isolate.
`-peer`	Account alias	default

Results

Report: isolated

This report shows the transaction result. The command will generate a report in three different formats. isolated.csv, isolated.json, and isolated.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.shared_folder_id	The ID of the shared folder.
input.name	The name of the this shared folder.
input.access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
input.path_lower	The lower-cased full path of this shared folder.
input.is_inside_team_folder	Whether this folder is inside of a team folder.
input.is_team_folder	Whether this folder is a team folder.
input.policy_manage_access	Who can add and remove members from this shared folder.
input.policy_shared_link	Who links can be shared with.
input.policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
input.policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
input.policy_viewer_info	Who can enable/disable viewer info for this shared folder.
input.owner_team_name	Team name of the team that owns the folder
input.access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; isolated_0000.xlsx, isolated_0001.xlsx, isolated_0002.xlsx, …

Title: dropbox team runas sharedfolder list URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/list.md —

dropbox team runas sharedfolder list

List shared folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder list -member-email EMAIL

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to list.	root
`-member-email`	Email address of the member to list.
`-peer`	Account alias	default

Results

Report: shared_folder

This report shows a list of shared folders. The command will generate a report in three different formats. shared_folder.csv, shared_folder.json, and shared_folder.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; shared_folder_0000.xlsx, shared_folder_0001.xlsx, shared_folder_0002.xlsx, …

Title: dropbox team runas sharedfolder batch leave URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/batch/leave.md —

dropbox team runas sharedfolder batch leave

Leave shared folders in batch

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder batch leave -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to leave.	root
`-file`	Path to data file
`-keep-copy`	Keep a copy of the folder after leaving.	false
`-peer`	Account alias	default

File formats

Format: File

List of member folders for batch operations.

Column	Description	Example
member_email	Email address of the member.	member@example.com
path	Path to the member’s folder.	/Team Folder/Shared/file.txt

The first line is a header line. The program will accept a file without the header.

member_email,path
member@example.com,/Team Folder/Shared/file.txt

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.member_email	Email address of the member.
input.path	Path to the member’s folder.
result.shared_folder_id	The ID of the shared folder.
result.parent_shared_folder_id	The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
result.name	The name of the this shared folder.
result.access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
result.path_lower	The lower-cased full path of this shared folder.
result.is_inside_team_folder	Whether this folder is inside of a team folder.
result.is_team_folder	Whether this folder is a team folder.
result.policy_manage_access	Who can add and remove members from this shared folder.
result.policy_shared_link	Who links can be shared with.
result.policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
result.policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
result.policy_viewer_info	Who can enable/disable viewer info for this shared folder.
result.owner_team_id	Team ID of the folder owner team
result.owner_team_name	Team name of the team that owns the folder
result.access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team runas sharedfolder batch share URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/batch/share.md —

Share shared folders in batch

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder batch share -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-acl-update-policy`	Access control update policy.	owner
`-base-path`	Base path of the shared folder to share.	root
`-file`	Path to data file
`-member-policy`	Policy for shared folder members.	anyone
`-peer`	Account alias	default
`-shared-link-policy`	Policy for shared links.	anyone

File formats

Format: File

List of member folders for batch operations.

Column	Description	Example
member_email	Email address of the member.	member@example.com
path	Path to the member’s folder.	/Team Folder/Shared/file.txt

The first line is a header line. The program will accept a file without the header.

member_email,path
member@example.com,/Team Folder/Shared/file.txt

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.member_email	Email address of the member.
input.path	Path to the member’s folder.
result.shared_folder_id	The ID of the shared folder.
result.parent_shared_folder_id	The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
result.name	The name of the this shared folder.
result.access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
result.path_lower	The lower-cased full path of this shared folder.
result.is_inside_team_folder	Whether this folder is inside of a team folder.
result.is_team_folder	Whether this folder is a team folder.
result.policy_manage_access	Who can add and remove members from this shared folder.
result.policy_shared_link	Who links can be shared with.
result.policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
result.policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
result.policy_viewer_info	Who can enable/disable viewer info for this shared folder.
result.owner_team_id	Team ID of the folder owner team
result.owner_team_name	Team name of the team that owns the folder
result.access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team runas sharedfolder batch unshare URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/batch/unshare.md —

dropbox team runas sharedfolder batch unshare

Unshare shared folders in batch

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder batch unshare -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to unshare.	root
`-file`	Path to data file
`-leave-copy`	Leave a copy after unsharing.	false
`-peer`	Account alias	default

File formats

Format: File

List of member folders for batch operations.

Column	Description	Example
member_email	Email address of the member.	member@example.com
path	Path to the member’s folder.	/Team Folder/Shared/file.txt

The first line is a header line. The program will accept a file without the header.

member_email,path
member@example.com,/Team Folder/Shared/file.txt

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.member_email	Email address of the member.
input.path	Path to the member’s folder.
result.shared_folder_id	The ID of the shared folder.
result.parent_shared_folder_id	The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
result.name	The name of the this shared folder.
result.access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
result.path_lower	The lower-cased full path of this shared folder.
result.is_inside_team_folder	Whether this folder is inside of a team folder.
result.is_team_folder	Whether this folder is a team folder.
result.policy_manage_access	Who can add and remove members from this shared folder.
result.policy_shared_link	Who links can be shared with.
result.policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
result.policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
result.policy_viewer_info	Who can enable/disable viewer info for this shared folder.
result.owner_team_id	Team ID of the folder owner team
result.owner_team_name	Team name of the team that owns the folder
result.access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team runas sharedfolder member batch add URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/member/batch/add.md —

dropbox team runas sharedfolder member batch add

Add members to shared folders in batch

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder member batch add -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to add members.	root
`-file`	Path to data file
`-message`	Message to send to new members.
`-peer`	Account alias	default
`-silent`	Add members silently without notification.	false

File formats

Format: File

Details of the member to add.

Column	Description	Example
member_email	Email address of the member to add.	member@example.com
path	Path to the shared folder.	/Team Folder/Shared/file.txt
access_level	Access level to grant to the member.	editor
group_or_email	Group name or email address to add.	group@example.com

The first line is a header line. The program will accept a file without the header.

member_email,path,access_level,group_or_email
member@example.com,/Team Folder/Shared/file.txt,editor,group@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.member_email	Email address of the member to add.
input.path	Path to the shared folder.
input.access_level	Access level to grant to the member.
input.group_or_email	Group name or email address to add.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team runas sharedfolder member batch delete URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/member/batch/delete.md —

dropbox team runas sharedfolder member batch delete

Remove members from shared folders in batch

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder member batch delete -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to remove members.	root
`-file`	Path to data file
`-leave-copy`	Leave a copy after removing member.	false
`-peer`	Account alias	default

File formats

Format: File

Details of the member to remove.

Column	Description	Example
member_email	Email address of the member to remove.	member@example.com
path	Path to the shared folder.	/Team Folder/Shared/file.txt
group_or_email	Group name or email address to remove.	group@example.com

The first line is a header line. The program will accept a file without the header.

member_email,path,group_or_email
member@example.com,/Team Folder/Shared/file.txt,group@example.com

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.member_email	Email address of the member to remove.
input.path	Path to the shared folder.
input.group_or_email	Group name or email address to remove.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team runas sharedfolder mount add URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/mount/add.md —

dropbox team runas sharedfolder mount add

Mount a shared folder as another member

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder mount add -member-email EMAIL -shared-folder-id SHARED_FOLDER_ID

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to mount.	root
`-member-email`	Email address of the member
`-peer`	Account alias	default
`-shared-folder-id`	Shared folder ID

Results

Report: mount

This report shows a list of shared folders. The command will generate a report in three different formats. mount.csv, mount.json, and mount.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mount_0000.xlsx, mount_0001.xlsx, mount_0002.xlsx, …

Title: dropbox team runas sharedfolder mount delete URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/mount/delete.md —

dropbox team runas sharedfolder mount delete

The specified user unmounts the designated folder.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder mount delete -member-email EMAIL -shared-folder-id SHARED_FOLDER_ID

Options:

Option	Description	Default
`-base-path`	Base path of the shared folder to unmount.	root
`-member-email`	Email address of the member
`-peer`	Account alias	default
`-shared-folder-id`	The ID for the shared folder.

Results

Report: mount

This report shows a list of shared folders. The command will generate a report in three different formats. mount.csv, mount.json, and mount.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mount_0000.xlsx, mount_0001.xlsx, mount_0002.xlsx, …

Title: dropbox team runas sharedfolder mount list URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/mount/list.md —

dropbox team runas sharedfolder mount list

List all shared folders the specified member mounted

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder mount list -member-email EMAIL

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-member-email`	Member email address
`-peer`	Account alias	default

Results

Report: mounts

This report shows a list of shared folders. The command will generate a report in three different formats. mounts.csv, mounts.json, and mounts.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mounts_0000.xlsx, mounts_0001.xlsx, mounts_0002.xlsx, …

Title: dropbox team runas sharedfolder mount mountable URL: https://toolbox.watermint.org/commands/dropbox/team/runas/sharedfolder/mount/mountable.md —

dropbox team runas sharedfolder mount mountable

List all shared folders the member can mount

Usage

This document uses the Desktop folder for command example.

tbx dropbox team runas sharedfolder mount mountable -member-email EMAIL

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-include-mounted`	Include mounted folders.	false
`-member-email`	Member email address
`-peer`	Account alias	default

Results

Report: mountables

This report shows a list of shared folders. The command will generate a report in three different formats. mountables.csv, mountables.json, and mountables.xlsx.

Column	Description
shared_folder_id	The ID of the shared folder.
name	The name of the this shared folder.
access_type	The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
path_lower	The lower-cased full path of this shared folder.
is_inside_team_folder	Whether this folder is inside of a team folder.
is_team_folder	Whether this folder is a team folder.
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member_folder	Who can be a member of this shared folder, as set on the folder itself.
policy_member	Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
policy_viewer_info	Who can enable/disable viewer info for this shared folder.
owner_team_name	Team name of the team that owns the folder
access_inheritance	Access inheritance type

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; mountables_0000.xlsx, mountables_0001.xlsx, mountables_0002.xlsx, …

Title: dropbox team sharedlink list URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/list.md —

dropbox team sharedlink list

List of shared links

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-peer`	Account alias	default
`-visibility`	Filter links by visibility (all/public/team_only/password)	all

Results

Report: shared_link

This report shows a list of shared links with the shared link owner team member. The command will generate a report in three different formats. shared_link.csv, shared_link.json, and shared_link.xlsx.

Column	Description
tag	Entry type (file, or folder)
url	URL of the shared link.
name	The linked file name (including extension).
expires	Expiration time, if set.
path_lower	The lowercased full path in the user’s Dropbox.
visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
email	Email address of user.
status	The user’s status as a member of a specific team. (active/invited/suspended/removed)
surname	Surname of the link owner
given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; shared_link_0000.xlsx, shared_link_0001.xlsx, shared_link_0002.xlsx, …

Title: dropbox team sharedlink cap expiry URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/cap/expiry.md —

dropbox team sharedlink cap expiry

Set expiry cap to shared links in the team (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink cap expiry -at "+72h" -file /PATH/TO/shared_link_list.csv

Options:

Option	Description	Default
`-at`	New expiry date/time
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Target shared link

Column	Description	Example
url	Shared link URL	https://www.dropbox.com/scl/fo/fir9vjelf

The first line is a header line. The program will accept a file without the header.

url
https://www.dropbox.com/scl/fo/fir9vjelf

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Shared link URL
result.tag	Entry type (file, or folder)
result.url	URL of the shared link.
result.name	The linked file name (including extension).
result.expires	Expiration time, if set.
result.path_lower	The lowercased full path in the user’s Dropbox.
result.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
result.email	Email address of user.
result.surname	Surname of the link owner
result.given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team sharedlink cap visibility URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/cap/visibility.md —

dropbox team sharedlink cap visibility

Set visibility cap to shared links in the team (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink cap visibility -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-new-visibility`	New visibility setting	team_only
`-peer`	Account alias	default

File formats

Format: File

Target shared link

Column	Description	Example
url	Shared link URL	https://www.dropbox.com/scl/fo/fir9vjelf

The first line is a header line. The program will accept a file without the header.

url
https://www.dropbox.com/scl/fo/fir9vjelf

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Shared link URL
result.tag	Entry type (file, or folder)
result.url	URL of the shared link.
result.name	The linked file name (including extension).
result.expires	Expiration time, if set.
result.path_lower	The lowercased full path in the user’s Dropbox.
result.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
result.email	Email address of user.
result.surname	Surname of the link owner
result.given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team sharedlink delete links URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/delete/links.md —

dropbox team sharedlink delete links

Batch delete shared links (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink delete links -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Target shared link

Column	Description	Example
url	Shared link URL	https://www.dropbox.com/scl/fo/fir9vjelf

The first line is a header line. The program will accept a file without the header.

url
https://www.dropbox.com/scl/fo/fir9vjelf

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Shared link URL
result.tag	Entry type (file, or folder)
result.url	URL of the shared link.
result.name	The linked file name (including extension).
result.expires	Expiration time, if set.
result.path_lower	The lowercased full path in the user’s Dropbox.
result.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
result.email	Email address of user.
result.surname	Surname of the link owner
result.given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team sharedlink delete member URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/delete/member.md —

dropbox team sharedlink delete member

Delete all shared links of the member (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink delete member -member-email EMAIL

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-member-email`	Member email address
`-peer`	Account alias	default

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Shared link URL
result.tag	Entry type (file, or folder)
result.url	URL of the shared link.
result.name	The linked file name (including extension).
result.expires	Expiration time, if set.
result.path_lower	The lowercased full path in the user’s Dropbox.
result.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
result.email	Email address of user.
result.surname	Surname of the link owner
result.given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team sharedlink update expiry URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/update/expiry.md —

dropbox team sharedlink update expiry

Update expiration date of public shared links within the team (Irreversible operation)

Note: From Release 87, this command will receive a file to select shared links to update. If you wanted to update the expiry for all shared links in the team, please consider using a combination of dropbox team sharedlink list. For example, if you are familiar with the command jq, then you can do an equivalent operation as like below (force expiry within 28 days for every public link).

tbx team sharedlink list -output json -visibility public | jq '.sharedlink.url' | tbx team sharedlink update expiry -file - -at +720h

From Release 92, the command will not receive the argument -days. If you want to set a relative date/time, please use -at +HOURh like +720h (720 hours = 30 days).

Commands dropbox team sharedlink update is for setting a value to the shared links. Commands dropbox team sharedlink cap is for putting a cap value to the shared links. For example: if you set expiry by dropbox team sharedlink update expiry with the expiration date 2021-05-06. The command will update the expiry to 2021-05-06 even if the existing link has a shorter expiration date like 2021-05-04.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink update expiry -file /PATH/TO/DATA_FILE.csv -at +720h

Options:

Option	Description	Default
`-at`	New expiration date and time
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Target shared link

Column	Description	Example
url	Shared link URL	https://www.dropbox.com/scl/fo/fir9vjelf

The first line is a header line. The program will accept a file without the header.

url
https://www.dropbox.com/scl/fo/fir9vjelf

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Shared link URL
result.tag	Entry type (file, or folder)
result.url	URL of the shared link.
result.name	The linked file name (including extension).
result.expires	Expiration time, if set.
result.path_lower	The lowercased full path in the user’s Dropbox.
result.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
result.email	Email address of user.
result.surname	Surname of the link owner
result.given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team sharedlink update password URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/update/password.md —

dropbox team sharedlink update password

Set or update shared link passwords (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink update password -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Shared link / password pair list

Column	Description	Example
url	Shared link URL	https://www.dropbox.com/scl/fo/fir9vjelf
password	Shared link password	STRONG_PASSWORD

The first line is a header line. The program will accept a file without the header.

url,password
https://www.dropbox.com/scl/fo/fir9vjelf,STRONG_PASSWORD

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Shared link URL
result.tag	Entry type (file, or folder)
result.url	URL of the shared link.
result.name	The linked file name (including extension).
result.expires	Expiration time, if set.
result.path_lower	The lowercased full path in the user’s Dropbox.
result.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
result.email	Email address of user.
result.surname	Surname of the link owner
result.given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team sharedlink update visibility URL: https://toolbox.watermint.org/commands/dropbox/team/sharedlink/update/visibility.md —

dropbox team sharedlink update visibility

Update visibility of shared links (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team sharedlink update visibility -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-file`	Path to data file
`-new-visibility`	New visibility setting	team_only
`-peer`	Account alias	default

File formats

Format: File

Target shared link

Column	Description	Example
url	Shared link URL	https://www.dropbox.com/scl/fo/fir9vjelf

The first line is a header line. The program will accept a file without the header.

url
https://www.dropbox.com/scl/fo/fir9vjelf

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.url	Shared link URL
result.tag	Entry type (file, or folder)
result.url	URL of the shared link.
result.name	The linked file name (including extension).
result.expires	Expiration time, if set.
result.path_lower	The lowercased full path in the user’s Dropbox.
result.visibility	The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder).
result.email	Email address of user.
result.surname	Surname of the link owner
result.given_name	Given name of the link owner

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team teamfolder add URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/add.md —

dropbox team teamfolder add

Add team folder to the team (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder add -name NAME

Options:

Option	Description	Default
`-name`	Team folder name
`-peer`	Account alias	default
`-sync-setting`	Sync setting for the team folder	default

Results

Report: added

This report shows a list of team folders in the team. The command will generate a report in three different formats. added.csv, added.json, and added.xlsx.

Column	Description
name	The name of the team folder.
status	The status of the team folder (active, archived, or archive_in_progress)
is_team_shared_dropbox	True if the team has team shared Dropbox
sync_setting	The sync setting applied to this team folder (default, not_synced, or not_synced_inactive)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; added_0000.xlsx, added_0001.xlsx, added_0002.xlsx, …

Title: dropbox team teamfolder archive URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/archive.md —

dropbox team teamfolder archive

Archive team folder (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder archive -name TEAMFOLDER_NAME

Options:

Option	Description	Default
`-name`	Team folder name
`-peer`	Account alias	default

Title: dropbox team teamfolder list URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/list.md —

dropbox team teamfolder list

List team folder(s)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder list

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: team_folder

This report shows a list of team folders in the team. The command will generate a report in three different formats. team_folder.csv, team_folder.json, and team_folder.xlsx.

Column	Description
name	The name of the team folder.
status	The status of the team folder (active, archived, or archive_in_progress)
is_team_shared_dropbox	True if the team has team shared Dropbox
sync_setting	The sync setting applied to this team folder (default, not_synced, or not_synced_inactive)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; team_folder_0000.xlsx, team_folder_0001.xlsx, team_folder_0002.xlsx, …

Title: dropbox team teamfolder permdelete URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/permdelete.md —

dropbox team teamfolder permdelete

Permanently delete team folder (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder permdelete -name TEAMFOLDER_NAME

Options:

Option	Description	Default
`-name`	Team folder name
`-peer`	Account alias	default

Title: dropbox team teamfolder replication URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/replication.md —

dropbox team teamfolder replication

Replicate a team folder to the other team (Experimental, and Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder replication -name NAME

Options:

Option	Description	Default
`-dst-peer-name`	Destination team account alias	dst
`-name`	Team folder name
`-src-peer-name`	Source team account alias	src

Results

Report: verification

This report shows a difference between to folders. The command will generate a report in three different formats. verification.csv, verification.json, and verification.xlsx.

Column	Description
diff_type	Type of difference. `file_content_diff`: different content hash, `{left\|right}_file_missing`: left or right file missing, `{left\|right}_folder_missing`: left or right folder missing.
left_path	path of left
left_kind	folder or file
left_size	size of left file
left_hash	Content hash of left file
right_path	path of right
right_kind	folder of file
right_size	size of right file
right_hash	Content hash of right file

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; verification_0000.xlsx, verification_0001.xlsx, verification_0002.xlsx, …

Title: dropbox team teamfolder batch archive URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/batch/archive.md —

dropbox team teamfolder batch archive

Archiving team folders (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder batch archive -file /path/to/file.csv

Options:

Option	Description	Default
`-file`	Data file for a list of team folder names
`-peer`	Account alias	default

File formats

Format: File

Data file for batch creating team folders.

Column	Description	Example
name	Name of team folder	Sales

The first line is a header line. The program will accept a file without the header.

name
Sales

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.name	Name of team folder
result.name	The name of the team folder.
result.status	The status of the team folder (active, archived, or archive_in_progress)
result.is_team_shared_dropbox	True if the team has team shared Dropbox
result.sync_setting	The sync setting applied to this team folder (default, not_synced, or not_synced_inactive)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team teamfolder batch permdelete URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/batch/permdelete.md —

dropbox team teamfolder batch permdelete

Permanently delete team folders (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder batch permdelete -file /path/to/file.csv

Options:

Option	Description	Default
`-file`	Data file for a list of team folder names
`-peer`	Account alias	default

File formats

Format: File

Data file for batch creating team folders.

Column	Description	Example
name	Name of team folder	Sales

The first line is a header line. The program will accept a file without the header.

name
Sales

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.name	Name of team folder

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team teamfolder batch replication URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/batch/replication.md —

dropbox team teamfolder batch replication

Batch replication of team folders (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder batch replication -file TEAMFOLDER_NAME_LIST.csv

Options:

Option	Description	Default
`-dst-peer-name`	Destination team account alias	dst
`-file`	Data file for a list of team folder names
`-src-peer-name`	Source team account alias	src

File formats

Format: File

Data file for batch creating team folders.

Column	Description	Example
name	Name of team folder	Sales

The first line is a header line. The program will accept a file without the header.

name
Sales

Results

Report: verification

This report shows a difference between to folders. The command will generate a report in three different formats. verification.csv, verification.json, and verification.xlsx.

Column	Description
diff_type	Type of difference. `file_content_diff`: different content hash, `{left\|right}_file_missing`: left or right file missing, `{left\|right}_folder_missing`: left or right folder missing.
left_path	path of left
left_kind	folder or file
left_size	size of left file
left_hash	Content hash of left file
right_path	path of right
right_kind	folder of file
right_size	size of right file
right_hash	Content hash of right file

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; verification_0000.xlsx, verification_0001.xlsx, verification_0002.xlsx, …

Title: dropbox team teamfolder file list URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/file/list.md —

dropbox team teamfolder file list

List files in team folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder file list

Options:

Option	Description	Default
`-folder-name`	List only for the folder matched to the name. Filter by exact match to the name.
`-folder-name-prefix`	List only for the folder matched to the name. Filter by name match to the prefix.
`-folder-name-suffix`	List only for the folder matched to the name. Filter by name match to the suffix.
`-peer`	Account alias	default

Results

Report: errors

This report shows the transaction result. The command will generate a report in three different formats. errors.csv, errors.json, and errors.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.namespace	Namespace
input.path	Path

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; errors_0000.xlsx, errors_0001.xlsx, errors_0002.xlsx, …

Report: namespace_file

This report shows a list of namespaces in the team. The command will generate a report in three different formats. namespace_file.csv, namespace_file.json, and namespace_file.xlsx.

Column	Description
namespace_type	The type of this namespace (app_folder, shared_folder, team_folder, or team_member_folder)
namespace_name	The name of this namespace
namespace_member_email	If this is a team member or app folder, the email address of the owning team member.
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; namespace_file_0000.xlsx, namespace_file_0001.xlsx, namespace_file_0002.xlsx, …

Title: dropbox team teamfolder file size URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/file/size.md —

dropbox team teamfolder file size

Calculate size of team folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder file size

Options:

Option	Description	Default
`-depth`	Depth	3
`-folder-name`	List only for the folder matched to the name. Filter by exact match to the name.
`-folder-name-prefix`	List only for the folder matched to the name. Filter by name match to the prefix.
`-folder-name-suffix`	List only for the folder matched to the name. Filter by name match to the suffix.
`-peer`	Account alias	default

Results

Report: namespace_size

Namespace size in bytes The command will generate a report in three different formats. namespace_size.csv, namespace_size.json, and namespace_size.xlsx.

Column	Description
namespace_name	The name of this namespace
namespace_id	The ID of this namespace.
namespace_type	The type of this namespace (app_folder, shared_folder, team_folder, or team_member_folder)
owner_team_member_id	If this is a team member or app folder, the ID of the owning team member.
path	Path to the folder
count_file	Number of files under the folder
count_folder	Number of folders under the folder
count_descendant	Number of files and folders under the folder
size	Size of the folder
depth	Namespace depth
mod_time_earliest	Earliest modification time in namespace
mod_time_latest	Latest modification time in namespace
api_complexity	Folder complexity index for API operations

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; namespace_size_0000.xlsx, namespace_size_0001.xlsx, namespace_size_0002.xlsx, …

Title: dropbox team teamfolder file lock list URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/file/lock/list.md —

dropbox team teamfolder file lock list

List locks in the team folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder file lock list -path /DROPBOX/PATH/TO/LIST -team-folder NAME

Options:

Option	Description	Default
`-path`	Path
`-peer`	Account alias	default
`-team-folder`	Team folder name

Results

Report: lock

Lock information The command will generate a report in three different formats. lock.csv, lock.json, and lock.xlsx.

Column	Description
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
size	The file size in bytes.
is_lock_holder	True if caller holds the file lock
lock_holder_name	The display name of the lock holder.
lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; lock_0000.xlsx, lock_0001.xlsx, lock_0002.xlsx, …

Title: dropbox team teamfolder file lock release URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/file/lock/release.md —

dropbox team teamfolder file lock release

Release lock of the path in the team folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder file lock release -path /DROPBOX/PATH/TO/RELEASE -team-folder NAME

Options:

Option	Description	Default
`-path`	Path to release lock
`-peer`	Account alias	default
`-team-folder`	Team folder name

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team teamfolder file lock all release URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/file/lock/all/release.md —

dropbox team teamfolder file lock all release

Release all locks under the path of the team folder

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder file lock all release -path /DROPBOX/PATH/TO/RELEASE -team-folder NAME

Options:

Option	Description	Default
`-batch-size`	Operation batch size	100
`-path`	Path to release lock
`-peer`	Account alias	default
`-team-folder`	Team folder name

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path
result.tag	Type of entry. `file`, `folder`, or `deleted`
result.client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
result.server_modified	The last time the file was modified on Dropbox.
result.size	The file size in bytes.
result.is_lock_holder	True if caller holds the file lock
result.lock_holder_name	The display name of the lock holder.
result.lock_created	The timestamp of the lock was created.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team teamfolder member add URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/member/add.md —

dropbox team teamfolder member add

Batch adding users/groups to team folders (Irreversible operation)

This command will do (1) create new team folders or new sub-folders if the team folder does not exist. The command does not (2) change access inheritance setting of any folders, (3) create a group if that not exist. This command is designed to be idempotent. You can safely retry if any errors happen on the operation. The command will not report an error to keep idempotence. For example, the command will not report an error like, the member already have access to the folder.

Example:

Sales (team folder, editor access for the group “Sales”)
- Sydney (viewer access for individual account sydney@example.com)
- Tokyo (editor access for the group “Tokyo Deal Desk”)
  - Monthly (viewer access for individual account success@example.com)
Marketing (team folder, editor access for the group “Marketing”)
- Sydney (editor access for the group “Sydney Sales”)
- Tokyo (viewer access for the group “Tokyo Sales”)

Prepare CSV like below

Sales,,editor,Sales
Sales,Sydney,editor,sydney@example.com
Sales,Tokyo,editor,Tokyo Deal Desk
Sales,Tokyo/Monthly,viewer,success@example.com
Marketing,,editor,Marketing
Marketing,Sydney,editor,Sydney Sales
Marketing,Tokyo,viewer,Tokyo Sales

Then run the command like below

tbx teamfolder member add -file /PATH/TO/DATA.csv

Note: the command will create a team folder if not exist. But the command will not a group if not found. Groups must exist before run this command.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder member add -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-admin-group-name`	Temporary group name for admin operation	watermint-toolbox-admin
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Team folder and member list for adding access. Each row can have one member and the one folder. If you want to add two or more members to the folder, please create rows for those members. Similarly, if you want to add a member to two or more folders, please create rows for those folders.

Column	Description	Example
team_folder_name	Team folder name	Sales
path	Relative path from the team folder root. Leave empty if you want to add a member to root of the team folder.	Report
access_type	Access type (viewer/editor)	editor
group_name_or_member_email	Group name or member email address	Sales

The first line is a header line. The program will accept a file without the header.

team_folder_name,path,access_type,group_name_or_member_email
Sales,Report,editor,Sales

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.team_folder_name	Team folder name
input.path	Relative path from the team folder root. Leave empty if you want to add a member to root of the team folder.
input.access_type	Access type (viewer/editor)
input.group_name_or_member_email	Group name or member email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team teamfolder member delete URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/member/delete.md —

dropbox team teamfolder member delete

Batch removing users/groups from team folders (Irreversible operation)

The command does not (1) change access inheritance setting of any folders, (2) remove a group, (3) unshare a nested folder. For (3), that means the nested folder stays the same setting (e.g. shared link policy for the folder). This command is designed to be idempotent. You can safely retry if any errors happen on the operation. The command will not report an error to keep idempotence. For example, the command will not report an error like, (1) the member already lose access to the folder, (2) the folder is not found.

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder member delete -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-admin-group-name`	Temporary group name for admin operation	watermint-toolbox-admin
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Team folder and member list for removing access. Each row can have one member and the one folder. If you want to remove two or more members from the folder, please create rows for those members. Similarly, if you want to remove a member from two or more folders, please create rows for those folders.

Column	Description	Example
team_folder_name	Team folder name	Sales
path	Relative path from the team folder root. Leave empty if you want to add a member to root of the team folder.	Report
group_name_or_member_email	Group name or member email address	Sales

The first line is a header line. The program will accept a file without the header.

team_folder_name,path,group_name_or_member_email
Sales,Report,Sales

Results

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.team_folder_name	Team folder name
input.path	Relative path from the team folder root. Leave empty if you want to add a member to root of the team folder.
input.group_name_or_member_email	Group name or member email address

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Title: dropbox team teamfolder member list URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/member/list.md —

dropbox team teamfolder member list

List team folder members

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder member list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-folder-name`	Filter by folder name. Filter by exact match to the name.
`-folder-name-prefix`	Filter by folder name. Filter by name match to the prefix.
`-folder-name-suffix`	Filter by folder name. Filter by name match to the suffix.
`-member-type-external`	Filter folder members. Keep only members are external (not in the same team). Note: Invited members are marked as external member.
`-member-type-internal`	Filter folder members. Keep only members are internal (in the same team). Note: Invited members are marked as external member.
`-peer`	Account alias	default
`-scan-timeout`	Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like `TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME`.	short

Results

Report: membership

Column	Description
path	Path
folder_type	Type of the folder. (`team_folder`: a team folder or in a team folder, `shared_folder`: a shared folder)
owner_team_name	Team name of the team that owns the folder
access_type	User’s access level for this folder
member_type	Type of this member (user, group, or invitee)
member_name	Name of this member
member_email	Email address of this member
same_team	Whether the member is in the same team or not. Returns empty if the member is not able to determine whether in the same team or not.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; membership_0000.xlsx, membership_0001.xlsx, membership_0002.xlsx, …

Report: no_member

This report shows folders without members. The command will generate a report in three different formats. no_member.csv, no_member.json, and no_member.xlsx.

Column	Description
owner_team_name	Team name of the team that owns the folder
path	Path
folder_type	Type of the folder. (`team_folder`: a team folder or in a team folder, `shared_folder`: a shared folder)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; no_member_0000.xlsx, no_member_0001.xlsx, no_member_0002.xlsx, …

Title: dropbox team teamfolder partial replication URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/partial/replication.md —

dropbox team teamfolder partial replication

Partial team folder replication to the other team (Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder partial replication -src-team-folder-name SRC_TEAMFOLDER_NAME -src-path /REL/PATH/SRC -dst-team-folder-name DST_TEAMFOLDER_NAME -dst-path /REL/PATH/DST

Options:

Option	Description	Default
`-base-path`	Base path for partial replication	root
`-dst`	Destination account alias	dst
`-dst-path`	Destination path
`-dst-team-folder-name`	Destination team folder name
`-src`	Peer name for the src team	src
`-src-path`	Relative path from the team folder (please specify ‘/’ for the team folder root)
`-src-team-folder-name`	Source team folder name

Title: dropbox team teamfolder policy list URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/policy/list.md —

dropbox team teamfolder policy list

List policies of team folders

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder policy list

Options:

Option	Description	Default
`-base-path`	Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn’t matter what you choose. In Dropbox for Teams, if you select `home` in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don’t need to include the folder name with your username in the path. On the other hand, if you specify `root`, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.	root
`-folder-name`	Filter by folder name. Filter by exact match to the name.
`-folder-name-prefix`	Filter by folder name. Filter by name match to the prefix.
`-folder-name-suffix`	Filter by folder name. Filter by name match to the suffix.
`-peer`	Account alias	default
`-scan-timeout`	Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like `TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME`.	short

Results

Report: policy

Column	Description
path	Path
is_team_folder	`true` if the folder is a team folder, or inside of a team folder
owner_team_name	Team name of the team that owns the folder
policy_manage_access	Who can add and remove members from this shared folder.
policy_shared_link	Who links can be shared with.
policy_member	Who can be a member of this shared folder, taking into account both the folder and the team-wide policy.
policy_viewer_info	Who can enable/disable viewer info for this shared folder.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; policy_0000.xlsx, policy_0001.xlsx, policy_0002.xlsx, …

Title: dropbox team teamfolder sync setting list URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/sync/setting/list.md —

dropbox team teamfolder sync setting list

List team folder sync settings

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder sync setting list

Options:

Option	Description	Default
`-peer`	Account alias	default
`-scan-all`	Perform a scan for all depths (can take considerable time depending on folder structure)	false
`-show-all`	Show all scanned folders	false

Results

Report: folders

This report shows a list of metadata of files or folders in the path. The command will generate a report in three different formats. folders.csv, folders.json, and folders.xlsx.

Column	Description
id	A unique identifier for the file.
tag	Type of entry. `file`, `folder`, or `deleted`
name	The last component of the path (including extension).
path_lower	The lowercased full path in the user’s Dropbox. This always starts with a slash.
path_display	The cased path to be used for display purposes only.
client_modified	For files, this is the modification time set by the desktop client when the file was added to Dropbox.
server_modified	The last time the file was modified on Dropbox.
revision	A unique identifier for the current revision of a file.
size	The file size in bytes.
content_hash	A hash of the file content.
has_explicit_shared_members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
shared_folder_id	If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
parent_shared_folder_id	ID of shared folder that holds this file.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; folders_0000.xlsx, folders_0001.xlsx, folders_0002.xlsx, …

Report: settings

Folder settings The command will generate a report in three different formats. settings.csv, settings.json, and settings.xlsx.

Column	Description
team_folder	Team folder name
path	Path (Relative to the team folder. Blank for first level)
sync_setting	Sync setting

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; settings_0000.xlsx, settings_0001.xlsx, settings_0002.xlsx, …

Title: dropbox team teamfolder sync setting update URL: https://toolbox.watermint.org/commands/dropbox/team/teamfolder/sync/setting/update.md —

dropbox team teamfolder sync setting update

Batch update team folder sync settings

Usage

This document uses the Desktop folder for command example.

tbx dropbox team teamfolder sync setting update -file /PATH/TO/DATA_FILE.csv

Options:

Option	Description	Default
`-file`	Path to data file
`-peer`	Account alias	default

File formats

Format: File

Sync settings for team folders

Column	Description	Example
path	Path to the target folder	/Sales/Forecast
sync_setting	Sync setting (default/not_synced)	not_synced

The first line is a header line. The program will accept a file without the header.

path,sync_setting
/Sales/Forecast,not_synced

Results

Report: updated

This report shows the transaction result. The command will generate a report in three different formats. updated.csv, updated.json, and updated.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.path	Path to the target folder
input.sync_setting	Sync setting (default/not_synced)
result.team_folder_id	Team folder ID
result.name	The name of the team folder.
result.status	The status of the team folder (active, archived, or archive_in_progress)

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; updated_0000.xlsx, updated_0001.xlsx, updated_0002.xlsx, …

Title: figma account info URL: https://toolbox.watermint.org/commands/figma/account/info.md —

figma account info

Retrieve current user information

Usage

This document uses the Desktop folder for command example.

tbx figma account info

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: user

User information The command will generate a report in three different formats. user.csv, user.json, and user.xlsx.

Column	Description
id	Unique stable id of the user
handle	Name of the user
img_url	URL link to the user’s profile image
email	Email associated with the user’s account

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; user_0000.xlsx, user_0001.xlsx, user_0002.xlsx, …

Title: figma file info URL: https://toolbox.watermint.org/commands/figma/file/info.md —

figma file info

Show information of the figma file

Usage

This document uses the Desktop folder for command example.

tbx figma file info -key FILE_KEY

Options:

Option	Description	Default
`-all-nodes`	Include all node information	false
`-key`	File key
`-peer`	Account alias	default

Results

Report: document

Figma Document The command will generate a report in three different formats. document.csv, document.json, and document.xlsx.

Column	Description
name	Name of the document
role	Your role
lastModified	Last modified timestamp
editorType	Figma editor type (figma/figjam)
version	Version of the document

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; document_0000.xlsx, document_0001.xlsx, document_0002.xlsx, …

Report: node

Node of the Figma document The command will generate a report in three different formats. node.csv, node.json, and node.xlsx.

Column	Description
id	Node ID
type	Type of the node
name	Name of the node
absoluteBoundingBox	Bounding box of the node in absolute space coordinates

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; node_0000.xlsx, node_0001.xlsx, node_0002.xlsx, …

Title: figma file list URL: https://toolbox.watermint.org/commands/figma/file/list.md —

figma file list

List files in the Figma Project

Usage

This document uses the Desktop folder for command example.

tbx figma file list -project-id PROJECT_ID. Use `services figma project list` command to retrieve PROJECT_IDs on your team.

Options:

Option	Description	Default
`-peer`	Account alias	default
`-project-id`	Project ID

Results

Report: files

Figma file The command will generate a report in three different formats. files.csv, files.json, and files.xlsx.

Column	Description
key	Figma file key
name	Name fo the document
thumbnailUrl	Thumbnail URL
lastModified	Last modified timestamp

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; files_0000.xlsx, files_0001.xlsx, files_0002.xlsx, …

Title: figma file export frame URL: https://toolbox.watermint.org/commands/figma/file/export/frame.md —

figma file export frame

Export all frames of the Figma file

Usage

This document uses the Desktop folder for command example.

tbx figma file export frame -key FILE_KEY -path /LOCAL/PATH/TO/EXPORT

Options:

Option	Description	Default
`-format`	Export format (png/jpg/svg/pdf)	pdf
`-key`	File key
`-path`	Output folder path
`-peer`	Account alias	default
`-scale`	Export scale in percent range from 1 to 400 (default 100)	100

Title: figma file export node URL: https://toolbox.watermint.org/commands/figma/file/export/node.md —

figma file export node

Export Figma document Node

Usage

This document uses the Desktop folder for command example.

tbx figma file export node -key FILE_KEY -id NODE_ID -path /LOCAL/PATH/TO/EXPORT

Options:

Option	Description	Default
`-format`	Export format (png/jpg/svg/pdf)	pdf
`-id`	Node ID
`-key`	File Key
`-path`	Output folder path
`-peer`	Account alias	default
`-scale`	Export scale in percent range from 1 to 400 (default 100)	100

Title: figma file export page URL: https://toolbox.watermint.org/commands/figma/file/export/page.md —

figma file export page

Export all pages of the Figma file

Usage

This document uses the Desktop folder for command example.

tbx figma file export page -key FILE_KEY -path /LOCAL/PATH/TO/EXPORT

Options:

Option	Description	Default
`-format`	Export format (png/jpg/svg/pdf)	pdf
`-key`	File key
`-path`	Output folder path
`-peer`	Account alias	default
`-scale`	Export scale in percent range from 1 to 400 (default 100)	100

Title: figma file export all page URL: https://toolbox.watermint.org/commands/figma/file/export/all/page.md —

figma file export all page

Export all files/pages under the team

This command exports all pages for the files below the team. However, if the same file already exists in the export destination, the watermint toolbox compares the timestamps and downloads only if there are updates. Also, if the page does not contain any content, the process is skipped.

Usage

This document uses the Desktop folder for command example.

tbx figma file export all page -path /LOCAL/PATH/TO/EXPORT -team-id TEAM_ID

Options:

Option	Description	Default
`-format`	Export format (png/jpg/svg/pdf)	pdf
`-path`	Output folder path
`-peer`	Account alias	default
`-scale`	Export scale in percent range from 1 to 400 (default 100)	100
`-team-id`	Team ID. To obtain a team id, navigate to a team page of a team you are a part of. The team id will be present in the URL after the word team and before your team name.

Title: figma project list URL: https://toolbox.watermint.org/commands/figma/project/list.md —

figma project list

List projects of the team

Usage

This document uses the Desktop folder for command example.

tbx figma project list -team-id TEAM_ID. To obtain a team id, navigate to a team page of a team you are a part of. The team id will be present in the URL after the word team and before your team name.

Options:

Option	Description	Default
`-peer`	Account alias	default
`-team-id`	Team ID. To obtain a team id, navigate to a team page of a team you are a part of. The team id will be present in the URL after the word team and before your team name.

Results

Report: projects

Figma project The command will generate a report in three different formats. projects.csv, projects.json, and projects.xlsx.

Column	Description
id	Figma Project ID
name	Name of the project

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; projects_0000.xlsx, projects_0001.xlsx, projects_0002.xlsx, …

Title: github profile URL: https://toolbox.watermint.org/commands/github/profile.md —

github profile

Get the authenticated user (Experimental)

Usage

This document uses the Desktop folder for command example.

tbx github profile

Options:

Option	Description	Default
`-peer`	Account alias	default

Results

Report: user

GitHub user profile The command will generate a report in three different formats. user.csv, user.json, and user.xlsx.

Column	Description
login	Login user name
name	Name of the user
url	Url of the user

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; user_0000.xlsx, user_0001.xlsx, user_0002.xlsx, …

Title: github content get URL: https://toolbox.watermint.org/commands/github/content/get.md —

github content get

Get content metadata of the repository

Usage

This document uses the Desktop folder for command example.

tbx github content get -owner OWNER -repository REPOSITORY -path PATH

Options:

Option	Description	Default
`-owner`	Owner of the repository
`-path`	Path to the content
`-peer`	Account alias	default
`-ref`	Name of reference
`-repository`	Name of the repository

Results

Report: content

Content metadata The command will generate a report in three different formats. content.csv, content.json, and content.xlsx.

Column	Description
type	Type of content
name	Name
path	Path
sha	SHA1
size	Size
target	Symlink target

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; content_0000.xlsx, content_0001.xlsx, content_0002.xlsx, …

Title: github content put URL: https://toolbox.watermint.org/commands/github/content/put.md —

github content put

Put small text content into the repository

Usage

This document uses the Desktop folder for command example.

tbx github content put  -owner OWNER -repository REPO -path PATH -content /LOCAL/PATH/TO/content -message MSG

Options:

Option	Description	Default
`-branch`	Name of the branch
`-content`	Path to a content file
`-message`	Commit message
`-owner`	Owner of the repository
`-path`	Path to the content
`-peer`	Account alias	default
`-repository`	Name of the repository

Results

Report: commit

Commit information The command will generate a report in three different formats. commit.csv, commit.json, and commit.xlsx.

Column	Description
sha	SHA1 of the commit
url	URL of the commit

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; commit_0000.xlsx, commit_0001.xlsx, commit_0002.xlsx, …

Title: github issue list URL: https://toolbox.watermint.org/commands/github/issue/list.md —

github issue list

List issues of the public/private GitHub repository (Experimental)

Usage

This document uses the Desktop folder for command example.

tbx github issue list -owner OWNER -repository REPO

Options:

Option	Description	Default
`-filter`	Indicates which sorts of issues to return.	assigned
`-labels`	A list of comma separated label names.
`-owner`	Owner of the repository
`-peer`	Account alias	default
`-repository`	Repository name
`-since`	Only show notifications updated after the given time.
`-state`	Indicates the state of the issues to return.	open

Results

Report: issues

GitHub Issue The command will generate a report in three different formats. issues.csv, issues.json, and issues.xlsx.

Column	Description
number	Issue number
url	URL of the issue
title	Title
state	Issue state

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; issues_0000.xlsx, issues_0001.xlsx, issues_0002.xlsx, …

Title: github release draft URL: https://toolbox.watermint.org/commands/github/release/draft.md —

github release draft

Create release draft (Experimental, and Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx github release draft -owner OWNER -repository REPO -body-file /LOCAL/PATH/TO/BODY.txt -branch BRANCH -name NAME -tag TAG

Options:

Option	Description	Default
`-body-file`	File path to body text. THe file must encoded in UTF-8 without BOM.
`-branch`	Name of the target branch
`-name`	Name of the release
`-owner`	Owner of the repository
`-peer`	Account alias	default
`-repository`	Name of the repository
`-tag`	Name of the tag

Results

Report: release

Release on GitHub The command will generate a report in three different formats. release.csv, release.json, and release.xlsx.

Column	Description
id	Release ID
tag_name	Release tag name
name	Release name
draft	Release is a draft
url	URL of the release

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; release_0000.xlsx, release_0001.xlsx, release_0002.xlsx, …

Title: github release list URL: https://toolbox.watermint.org/commands/github/release/list.md —

github release list

List releases (Experimental)

Usage

This document uses the Desktop folder for command example.

tbx github release list -owner OWNER -repository REPO

Options:

Option	Description	Default
`-owner`	Repository owner
`-peer`	Account alias	default
`-repository`	Repository name

Results

Report: releases

Release on GitHub The command will generate a report in three different formats. releases.csv, releases.json, and releases.xlsx.

Column	Description
tag_name	Release tag name
name	Release name
draft	Release is a draft
url	URL of the release

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; releases_0000.xlsx, releases_0001.xlsx, releases_0002.xlsx, …

Title: github release asset download URL: https://toolbox.watermint.org/commands/github/release/asset/download.md —

github release asset download

Download assets (Experimental)

Usage

This document uses the Desktop folder for command example.

tbx github release asset download -owner OWNER -repository REPO -path /LOCAL/PATH/TO/DOWNLOAD -release RELEASE

Options:

Option	Description	Default
`-owner`	Owner of the repository
`-path`	Path to download
`-peer`	Account alias	default
`-release`	Release tag name
`-repository`	Name of the repository

Results

Report: downloads

This report shows the transaction result. The command will generate a report in three different formats. downloads.csv, downloads.json, and downloads.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.file	File path

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; downloads_0000.xlsx, downloads_0001.xlsx, downloads_0002.xlsx, …

Title: github release asset list URL: https://toolbox.watermint.org/commands/github/release/asset/list.md —

github release asset list

List assets of GitHub Release (Experimental)

Usage

This document uses the Desktop folder for command example.

tbx github release asset list -owner OWNER -repository REPO -release RELEASE

Options:

Option	Description	Default
`-owner`	Owner of the repository
`-peer`	Account alias	default
`-release`	Release tag name
`-repository`	Name of the repository

Results

Report: assets

GitHub Release assets The command will generate a report in three different formats. assets.csv, assets.json, and assets.xlsx.

Column	Description
name	Name of the asset
size	Size of the asset
state	State of the asset
download_count	Number of downloads
download_url	Download URL

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; assets_0000.xlsx, assets_0001.xlsx, assets_0002.xlsx, …

Title: github release asset upload URL: https://toolbox.watermint.org/commands/github/release/asset/upload.md —

github release asset upload

Upload assets file into the GitHub Release (Experimental, and Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx github release asset upload -owner OWNER -repository REPO -release RELEASE -asset /LOCAL/PATH/TO/assets

Options:

Option	Description	Default
`-asset`	Path to assets
`-owner`	Owner of the repository
`-peer`	Account alias	default
`-release`	Release tag name
`-repository`	Name of the repository

Results

Report: uploads

This report shows the transaction result. The command will generate a report in three different formats. uploads.csv, uploads.json, and uploads.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.file	File path
result.name	Name of the asset
result.size	Size of the asset
result.state	State of the asset
result.download_count	Number of downloads
result.download_url	Download URL

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; uploads_0000.xlsx, uploads_0001.xlsx, uploads_0002.xlsx, …

Title: github tag create URL: https://toolbox.watermint.org/commands/github/tag/create.md —

github tag create

Create a tag on the repository (Experimental, and Irreversible operation)

Usage

This document uses the Desktop folder for command example.

tbx github tag create -owner OWNER -repository REPO -sha1 SHA -tag TAG

Options:

Option	Description	Default
`-owner`	Owner of the repository
`-peer`	Account alias	default
`-repository`	Name of the repository
`-sha1`	SHA1 hash of the commit
`-tag`	Tag name

Results

Report: created

This report shows the transaction result. The command will generate a report in three different formats. created.csv, created.json, and created.xlsx.

Column	Description
status	Status of the operation
reason	Reason of failure or skipped operation
input.owner	Owner of the repository
input.repository	Name of the repository
input.tag	Tag name
input.sha_1	SHA1 hash of the commit
result.tag	Tag name
result.sha	SHA1 sum of the commit
result.message	Message of the commit
result.url	URL of the tag

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; created_0000.xlsx, created_0001.xlsx, created_0002.xlsx, …

Title: local file template apply URL: https://toolbox.watermint.org/commands/local/file/template/apply.md —

local file template apply

Apply file/folder structure template to the local path

Usage

This document uses the Desktop folder for command example.

tbx local file template apply -path /LOCAL/PATH/TO/APPLY -template /LOCAL/PATH/TO/template.json

Options:

Option	Description	Default
`-path`	Path to apply template
`-template`	Path to template file

Title: local file template capture URL: https://toolbox.watermint.org/commands/local/file/template/capture.md —

local file template capture

Capture file/folder structure as template from local path

Usage

This document uses the Desktop folder for command example.

tbx local file template capture -out /LOCAL/PATH/template.json -path /LOCAL/PATH/TO/CAPTURE

Options:

Option	Description	Default
`-out`	Template output path
`-path`	Capture target path

Additional documents

Path variables

Title: Path variables URL: https://toolbox.watermint.org/guides/path-variables.md —

Path variables

Path variables are predefined variables which will be replaced on runtime. For example, if you specify a path with the variable like /Pictures, then the path will be replaced with actual path to Personal Dropbox’s folder. But the tool does not guarantee the existence or accuracy.

Path variable	Description
	Path to Dropbox Personal account root folder.
	Path to Dropbox for teams account root folder.
	Path to Dropbox for teams account root folder, or Personal Dropbox account if it not found.
	Path to Dropbox Personal account root folder, or Business Dropbox account if it not found.
	The home folder of the current user.
	The name of the current user.
	The host name of the current computer.
	Path to this program.
	Randomized 8 digit number leading with 0.
	Current local year with format ‘yyyy’ like 2021.
	Current local month with format ‘mm’ like 01.
	Current local day with format ‘dd’ like 05.
	Current local date with format yyyy-mm-dd.
	Current local time with format HH-MM-SS.
	Current UTC date with format yyyy-mm-dd.
	Current UTC time with format HH-MM-SS.

Experimental features

Title: Experimental features URL: https://toolbox.watermint.org/guides/experimental-features.md —

Experimental features

The experimental feature switch is for testing or accessing early access features. You can enable those features with the option -experiment. If you want to specify multiple features, please select those features joined with a comma. (e.g. -experiment feature1,feature2).

name	Description
batch_balance	Execute batch from the largest batch
batch_non_durable	Use non-durable batch framework
batch_random	Execute batch with random batchId order.
batch_sequential	Execute batch sequentially in same batchId.
congestion_window_aggressive	Apply aggressive initial congestion window size
congestion_window_no_limit	Do not limit concurrency with the congestion window.
dbx_auth_course_grained_scope	Requests all Dropbox authorization scopes instead of command-defined ones. This is used as a workaround in case the program does not work properly with the authorization scope defined in the command.
dbx_auth_redirect	Use redirect processing for authorization process to Dropbox
dbx_client_conditioner_error100	Simulate server errors. 100% of requests will fail with a server error.
dbx_client_conditioner_error20	Simulate server errors. 20% of requests will fail with a server error.
dbx_client_conditioner_error40	Simulate server errors. 40% of requests will fail with a server error.
dbx_client_conditioner_narrow100	Simulate rate limit errors. 100% of requests will fail with rate limitation.
dbx_client_conditioner_narrow20	Simulate rate limit errors. 20% of requests will fail with rate limitation.
dbx_client_conditioner_narrow40	Simulate rate limit errors. 40% of requests will fail with rate limitation.
dbx_disable_auto_path_root	Disable auto path root. When disabled, if a user’s home namespace is distinct from their root namespace, the user’s home namespace will be used as default for all API calls.
dbx_download_block	Download file divide by blocks (improve concurrency)
file_sync_disable_reduce_create_folder	Disable reduce create_folder on syncing file systems. That will create empty folder while syncing folders.
legacy_local_to_dbx_connector	Use legacy local to dropbox sync connector
use_no_cache_dbxfs	Use non-cache dropbox file system
kvs_badger	Use Badger as KVS engine
kvs_badger_turnstile	Use Badger as KVS engine with turnstile
kvs_bitcask	Use Bitcask as KVS engine
kvs_bitcask_turnstile	Use Bitcask as the key-value store with turnstile
kvs_sqlite	Use Sqlite3 as KVS engine
kvs_sqlite_turnstile	Use SQLite as the key-value store with turnstile
profile_cpu	Enable CPU profiler
profile_memory	Enable memory profiler
report_all_columns	Show all columns defined as data structure.
suppress_progress	Suppress progress indicators
validate_network_connection_on_bootstrap	Validate network connection on bootstrap

Troubleshooting

Title: Troubleshooting URL: https://toolbox.watermint.org/guides/troubleshooting.md —

Firewall or proxy server settings

The tool automatically detects proxy configuration from the system. However, that may fail or cause misconfiguration. In those cases, please use the -proxy option to specify proxy server hostname and port number like -proxy 192.168.1.1:8080 (for proxy server 192.168.1.1, and the port number 8080).

Note: This tool does not support proxy servers with any authentication such as Basic authentication or NTLM.

Performance issue

If the command feels slow or stalled, please try re-run with an option -verbose. That will show more detailed progress. But in most cases, the cause is simply you have a larger data to process. Otherwise, you already hit a rate limit from API servers. If you want to see rate limit status, please see capture logs and debug for more details.

The tool automatically adjusts concurrency to avoid additional limitation from API servers. If you want to see current concurrency, please run the command like below. That will show a current window size (maximum concurrency) per endpoint. The debug message “WaiterStatus” reports current concurrency and window sizes. The map “runners” is for operations currently waiting for a result from API servers. The map “window” is for window size for each endpoint. The map “concurrency” is for current concurrency per endpoint. The below example indicates for the endpoint “https://api.dropboxapi.com/2/file_requests/create”, the tool does not allow call that endpoint with the concurrency grater than one. That means it requires operation one by one, and there is no easy workaround to speed up operations.

tbx job log last -quiet | jq 'select(.msg == "WaiterStatus")' 
{
  "level": "DEBUG",
  "time": "2020-11-10T14:55:57.501+0900",
  "name": "z951.z960.z112064",
  "caller": "nw_congestion/congestion.go:310",
  "msg": "WaiterStatus",
  "goroutine": "gr:284877",
  "runners": {
    "gr:1": {
      "key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/file_requests/create",
      "go_routine_id": "gr:1",
      "running_since": "2020-11-10T14:55:56.124899+09:00"
    }
  },
  "numRunners": 1,
  "waiters": [],
  "numWaiters": 0,
  "window": {
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/team/token/get_authenticated_admin": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/team/token/get_authenticated_admin": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/team/token/get_authenticated_admin": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/team/token/get_authenticated_admin": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/file_requests/create": 1,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/list_folder": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/save_url": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/save_url/check_job_status": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/search/continue_v2": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/search_v2": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/users/get_current_account": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/copy_reference/get": 4,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/copy_v2": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/delete_v2": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/get_metadata": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/files/list_folder": 4,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/sharing/list_mountable_folders": 4,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://content.dropboxapi.com/2/files/download": 5,
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://content.dropboxapi.com/2/files/export": 4
  },
  "concurrency": {
    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-https://api.dropboxapi.com/2/file_requests/create": 1
  }
}

Garbled output

If the tool output garbled, please stop the tool with Ctrl+C. This issue usually happens when your console does not have a font to display it. Then, please try to change the font that supports your language. Or, please try the option -lang en to overwrite language setting of the tool to English.

In PowerShell, you can change the font with (1) right-click on the title bar, (2) click properties, (3) then choose the font tab, (4) then change to an appropriate font like “MS Gothic.”

Log files

By default, log files are stored under the path “%USERPROFILE%.toolbox\jobs” (e.g. C:\Users\USERNAME\.toolbox\jobs) on windows, or “$HOME.toolbox\jobs” in Linux or macOS (e.g. /Users/USERNAME/.toolbox/jobs). Log files contain information such as (1) Runtime information, e.g. OS type/version/environment variables, (2) Runtime options to the tool (including a copy of input data files), (3) Account information of services such as Dropbox, (4) Request and response data to API servers, (5) Data in services such as file name, metadata, id, URL etc. (depends on the command).

Those logs do not contain password, credentials, or API token. But API tokens are stored under the path “%USERPROFILE%.toolbox\secrets” (e.g. C:\Users\USERNAME\.toolbox\secrets) on windows, or “$HOME.toolbox\secrets” in Linux or macOS (e.g. /Users/USERNAME/.toolbox/secrets). These secrets folder files are obfuscated but please do not share these files to anyone including a service provider support such as Dropbox support.

Log format

There are several folders and files stored under the jobs folder. First, the job folder will be created every run with a name (internally called Job Id) with the format “yyyyMMdd-HHmmSS.xxx”. The first part “yyyyMMdd-HHmmSS” is for local date/time of the command start. The second part “.xxx” is the sequential or random three-character ID to avoid conflict with a concurrent run.

Under the job folder, there are subfolders (1) logs: runtime logs including request/response data, parameters, or debug information, (2) reports: reports folder is for manage generated reports, (3) kvs: KVS folder is for runtime database folder.

On troubleshooting, files under logs are essential to understand what happened in runtime. The tool generates several types of logs. Those logs are JSON Lines format. Note: JSON Lines is a format that separate data with line separators. Please see JSON Lines for more detail about the specification.

Some logs are compressed with gzip format. If a log compressed, then the file has a suffix ‘.gz’. Additionally, logs such as capture logs and toolbox logs are divided by certain size. If you want to analyze logs, please consider using job log commands. For example, job log last -quiet will report toolbox logs of the latest job with decompressed and concatenated.

Debug logs

The tool will record all debug information into debug logs that have a prefix “toolbox”. All records have a source code file name and line at the operation. If you find some suspicious error, then go to the source code and debug it. Some troubleshooting requires statistical analysis such as for performance tuning or out of memory. It is better to work with a tool such as grep or jq.

If you want to see heap size data in time series, please run the command like below. Then you can see time + heap size in CSV format.

tbx job log last -quiet | jq -r 'select(.msg == "Heap stats") | [.time, .HeapInuse] | @csv'
"2020-11-10T14:55:45.725+0900",18604032
"2020-11-10T14:55:50.725+0900",15130624
"2020-11-10T14:55:55.725+0900",17408000
"2020-11-10T14:56:00.725+0900",17014784
"2020-11-10T14:56:05.726+0900",19193856
"2020-11-10T14:56:10.725+0900",19136512
"2020-11-10T14:56:15.726+0900",16637952
"2020-11-10T14:56:20.725+0900",16678912
"2020-11-10T14:56:25.727+0900",16678912
"2020-11-10T14:56:30.730+0900",16678912
"2020-11-10T14:56:35.726+0900",16678912

API transaction logs

The toll will record API requests and responses into capture logs that have a prefix “capture”. This capture logs do not contain requests and responses of OAuth. Additionally, API token strings are replaced with <secret>.

Commands of Dropbox for teams

Title: Commands of Dropbox for teams URL: https://toolbox.watermint.org/guides/dropbox-business.md —

Member management commands

Information commands

Below commands are to retrieve information about team members.

Command	Description
dropbox team member list	List team member(s)
dropbox team member feature	List member feature settings
dropbox team member folder list	List folders for each member
dropbox team member quota list	List team member quota
dropbox team member quota usage	List team member storage usage
dropbox team activity user	Activities log per user

Basic management commands

Below commands are for managing team member accounts. Those commands are for a bulk operation by a CSV file.

Command	Description
dropbox team member batch invite	Invite member(s)
dropbox team member batch delete	Delete members
dropbox team member batch detach	Convert Dropbox for teams accounts to a Basic account
dropbox team member batch reinvite	Reinvite invited status members to the team
dropbox team member update batch email	Member email operation
dropbox team member update batch profile	Batch update member profiles
dropbox team member update batch visible	Disable directory restriction to members
dropbox team member update batch invisible	Enable directory restriction to members
dropbox team member quota batch update	Update team member quota

Member profile setting commands

Member profile commands are for bulk updating member profile information. If you need to update the members’ email addresses, use the ‘member update email command. The command 'member update email receives a CSV file to bulk update email addresses. If you need to update the member’s display name, use the ‘member update profile` command.

Command	Description
dropbox team member update batch email	Member email operation
dropbox team member update batch profile	Batch update member profiles

Member storage quota control commands

You can see existing member storage quota setting or usage by the dropbox team member quota list and dropbox team member quota usage command. If you need to update member quota, use the dropbox team member quota update command. The command dropbox team member quota update receives CSV input for bulk updating storage quota setting.

Command	Description
dropbox team member quota list	List team member quota
dropbox team member quota usage	List team member storage usage
dropbox team member quota batch update	Update team member quota

There are two types of commands available for suspending/unsuspending members. If you wanted to suspend/unsuspend a member one by one, please use `dropbox team member suspend` or `dropbox team member unsuspend`. Otherwise, if you want to suspend/unsuspend members through a CSV file, please use the `dropbox team member batch suspend` or `dropbox member batch unsuspend` command.

Suspend/unsuspend a member

Command	Description
dropbox team member suspend	Suspend a member
dropbox team member unsuspend	Unsuspend a member
dropbox team member batch suspend	Bulk suspend members
dropbox team member batch unsuspend	Bulk unsuspend members

Directory restriction commands

Directory restriction is the Dropbox for teams feature to hide a member from others. Below commands update this setting to hide or unhide members from others.

Command	Description
dropbox team member update batch visible	Disable directory restriction to members
dropbox team member update batch invisible	Enable directory restriction to members

Group commands

Group management commands

Below commands are for managing groups.

Command	Description
dropbox team group add	Create new group
dropbox team group batch add	Bulk adding groups
dropbox team group batch delete	Delete groups
dropbox team group delete	Delete group
dropbox team group list	List group(s)
dropbox team group rename	Rename the group
dropbox team group update type	Update group management type

Group member management commands

You can add/delete/update group members by the below commands. If you want to add/delete/update group members by CSV file, use dropbox team group member batch add, dropbox team group member batch delete, or dropbox team group member batch delete.

Command	Description
dropbox team group member add	Add a member to the group
dropbox team group member delete	Delete a member from the group
dropbox team group member list	List members of groups
dropbox team group member batch add	Bulk add members into groups
dropbox team group member batch delete	Delete members from groups
dropbox team group member batch update	Add or delete members from groups

Find and delete unused groups

There are two commands to find unused groups. The first command is dropbox team group list. The command dropbox team group list will report the number of members of each group. If it’s zero, a group is not currently used to adding permission to folders. If you want to see which folder uses each group, use the command dropbox team group folder list. dropbox team group folder list will report the group to folder mapping. The report group_with_no_folders will show groups with no folders. You can safely remove groups once if you check both the number of members and folders. After confirmation, you can bulk delete groups by using the command dropbox team group batch delete.

Command	Description
dropbox team group list	List group(s)
dropbox team group folder list	List folders of each group
dropbox team group batch delete	Delete groups

Team content commands

Admins’ can handle team folders, shared folders or member’s folder content thru Dropbox Business API. Please be careful to use those commands. The namespace is the term in Dropbox API that is for manage folder permissions or settings. Folder types such as shared folders, team folders, or nested folder in a team folder, member’s root folder or member’s app folder are all managed as a namespace. The namespace commands can handle all types of folders, including team folders and member’s folder. But commands for specific folder types have more features or detailed information in the report.

Team folder operation commands

You can create, archive or permanently delete team folders by using the below commands. Please consider using dropbox team teamfolder batch commands if you need to handle multiple team folders.

Command	Description
dropbox team teamfolder add	Add team folder to the team
dropbox team teamfolder archive	Archive team folder
dropbox team teamfolder batch archive	Archiving team folders
dropbox team teamfolder batch permdelete	Permanently delete team folders
dropbox team teamfolder batch replication	Batch replication of team folders
dropbox team teamfolder file size	Calculate size of team folders
dropbox team teamfolder list	List team folder(s)
dropbox team teamfolder permdelete	Permanently delete team folder
dropbox team teamfolder policy list	List policies of team folders
dropbox team teamfolder sync setting list	List team folder sync settings
dropbox team teamfolder sync setting update	Batch update team folder sync settings

Team folder permission commands

You can bulk add or delete members into team folders or sub-folders of a team folder through the below commands.

Command	Description
dropbox team teamfolder member list	List team folder members
dropbox team teamfolder member add	Batch adding users/groups to team folders
dropbox team teamfolder member delete	Batch removing users/groups from team folders

Team folder & shared folder commands

The below commands are for both team folders and shared folders of the team. If you wanted to know who are actually uses specific folders, please consider using the command dropbox team content mount list. Mount is a status a user add a shared folder to his/her Dropbox account.

Command	Description
dropbox team content member list	List team folder & shared folder members
dropbox team content member size	Count number of members of team folders and shared folders
dropbox team content mount list	List all mounted/unmounted shared folders of team members.
dropbox team content policy list	List policies of team folders and shared folders in the team

Namespace commands

Command	Description
dropbox team namespace list	List all namespaces of the team
dropbox team namespace summary	Report team namespace status summary.
dropbox team namespace file list	List all files and folders of the team namespaces
dropbox team namespace file size	List all files and folders of the team namespaces
dropbox team namespace member list	List members of shared folders and team folders in the team

Team file request commands

Command	Description
dropbox team filerequest list	List all file requests in the team

Member file commands

Command	Description
dropbox team member file permdelete	Permanently delete the file or folder at a given path of the team member.

Team insight

Team Insight is a feature of Dropbox Business that provides a view of team folder summary.

Command	Description
dropbox team insight scan	Scans team data for analysis
dropbox team insight scanretry	Retry scan for errors on the last scan
dropbox team insight summarize	Summarize team data for analysis
dropbox team insight report teamfoldermember	Report team folder members

Team shared link commands

The team shared link commands are capable of listing all shared links in the team or update/delete specified shared links.

Command	Description
dropbox team sharedlink list	List of shared links
dropbox team sharedlink cap expiry	Set expiry cap to shared links in the team
dropbox team sharedlink cap visibility	Set visibility cap to shared links in the team
dropbox team sharedlink update expiry	Update expiration date of public shared links within the team
dropbox team sharedlink update password	Set or update shared link passwords
dropbox team sharedlink update visibility	Update visibility of shared links
dropbox team sharedlink delete links	Batch delete shared links
dropbox team sharedlink delete member	Delete all shared links of the member

Difference between `dropbox team sharedlink cap` and `dropbox team sharedlink update`

Similarly, the command dropbox team sharedlink cap visibility will restrict visibility only when the link has less protected visibility. For example, if you want to ensure shared links without password to the team only. dropbox team sharedlink cap visibility will update visibility to the team only when a link is public and has no password.

Example (list links):

List all public links in the team

tbx team sharedlink list -visibility public

Results are stored in CSV, xlsx, and JSON format. You can modify the report for updating shared links. If you are familiar with the command jq, then they can create CSV file directly like below.

tbx team sharedlink list -output json | jq '.sharedlink.url' > all_links.csv

List links filtered by link owner email address:

tbx team sharedlink list -output json | jq 'select(.member.profile.email == "username@example.com") | .sharedlink.url'

Example (delete links):

Delete all link that listed in the CSV file

tbx team sharedlink delete links -file /PATH/TO/DATA.csv

If you are familiar with jq command, then they can send data directly from the pipe like below (pass single dash - to the -file option to read from standard input).

tbx team sharedlink list -visibility public -output json | tbx team sharedlink delete links -file -

File lock title

Dropbox Business file lock information

File lock member title

Command	Description
dropbox team member file lock all release	Release all locks under the path of the member
dropbox team member file lock list	List locks of the member under the path
dropbox team member file lock release	Release the lock of the path as the member

File lock team folder title

Command	Description
dropbox team teamfolder file list	List files in team folders
dropbox team teamfolder file lock all release	Release all locks under the path of the team folder
dropbox team teamfolder file lock list	List locks in the team folder
dropbox team teamfolder file lock release	Release lock of the path in the team folder

Activities log commands

The team activities log commands can export activities log by a certain filter or perspective.

Command	Description
dropbox team activity batch user	Scan activities for multiple users
dropbox team activity daily event	Report activities by day
dropbox team activity event	Event log
dropbox team activity user	Activities log per user

Connected applications and devices commands

The below commands can retrieve information about connected devices or applications in the team.

Command	Description
dropbox team device list	List all devices/sessions in the team
dropbox team device unlink	Unlink device sessions
dropbox team linkedapp list	List linked applications
dropbox team backup device status	Dropbox Backup device status change in the specified period

Other usecases

External ID

External ID is the attribute that is not shown in any user interface of Dropbox. This attribute is for keep a relationship between Dropbox and identity source (e.g. Active Directory, HR database) by identity management software such as Dropbox AD Connector. In case if you are using Dropbox AD Connector and you built a new Active Directory tree. You may need to clear existing external IDs to disconnect relationships with the old Active Directory tree and the new tree. If you skip clear external IDs, Dropbox AD Connector may unintentionally delete accounts during configuring to the new tree. If you want to see existing external IDs, use the dropbox team member list command. But the command will not include external ID by default. Please add the option -experiment report_all_columns like below.

tbx member list -experiment report_all_columns

Command	Description
dropbox team member list	List team member(s)
dropbox team member clear externalid	Clear external_id of members
dropbox team member update batch externalid	Update External ID of team members
dropbox team group list	List group(s)
dropbox team group clear externalid	Clear an external ID of a group

Data migration helper commands

Data migration helper commands copies member folders or team folders to another account or team. Please test before using those commands before actual data migration.

Command	Description
dropbox team member folder replication	Replicate a folder to another member’s personal folder
dropbox team member replication	Replicate team member files
dropbox team teamfolder partial replication	Partial team folder replication to the other team
dropbox team teamfolder replication	Replicate a team folder to the other team

Team info commands

Command	Description
dropbox team feature	Team feature
dropbox team filesystem	Identify team’s file system version
dropbox team info	Team information

Paper commands

Legacy paper commands

Commands for a team’s legacy Paper content. Please see official guide more detail about legacy Paper and migration

Command	Description
dropbox team content legacypaper count	Count number of Paper documents per member
dropbox team content legacypaper list	List team member Paper documents
dropbox team content legacypaper export	Export entire team member Paper documents into local path

Team admin commands

Below commands are for managing team admins.

Command	Description
dropbox team admin list	List admin roles of members
dropbox team admin role add	Add a new role to the member
dropbox team admin role clear	Remove all admin roles from the member
dropbox team admin role delete	Remove a role from the member
dropbox team admin role list	List admin roles of the team
dropbox team admin group role add	Add the role to members of the group
dropbox team admin group role delete	Delete the role from all members except of members of the exception group

Commands that run as a team member

You can run a command as a team member. For example, you can upload a file into member’s folder by using dropbox team runas file sync batch up.

Command	Description
dropbox team runas file list	List files and folders run as a member
dropbox team runas file batch copy	Batch copy files/folders as a member
dropbox team runas file sync batch up	Batch upstream sync with Dropbox
dropbox team runas sharedfolder list	List shared folders
dropbox team runas sharedfolder isolate	Isolate member from shared folder
dropbox team runas sharedfolder mount add	Mount a shared folder as another member
dropbox team runas sharedfolder mount delete	The specified user unmounts the designated folder.
dropbox team runas sharedfolder mount list	List all shared folders the specified member mounted
dropbox team runas sharedfolder mount mountable	List all shared folders the member can mount
dropbox team runas sharedfolder batch leave	Leave shared folders in batch
dropbox team runas sharedfolder batch share	Share shared folders in batch
dropbox team runas sharedfolder batch unshare	Unshare shared folders in batch
dropbox team runas sharedfolder member batch add	Add members to shared folders in batch
dropbox team runas sharedfolder member batch delete	Remove members from shared folders in batch

Legal hold

With legal holds, admins can place a legal hold on members of their team and view and export all the content that’s been created or modified by those members.

Command	Description
dropbox team legalhold add	Creates new legal hold policy.
dropbox team legalhold list	Retrieve existing policies
dropbox team legalhold member batch update	Update member list of legal hold policy
dropbox team legalhold member list	List members of the legal hold
dropbox team legalhold release	Releases a legal hold by Id
dropbox team legalhold revision list	List revisions under legal hold
dropbox team legalhold update desc	Update description of the legal hold policy
dropbox team legalhold update name	Update name of the legal hold policy

Notes:

Dropbox Business footnote information

Specification changes

Title: Specification changes URL: https://toolbox.watermint.org/guides/spec-change.md —

Spec Change Section

Path change

Details about path changes in the spec

| CLI path (from) | CLI path (to) | Description of path change | Prune after build date | |—————–|—————|—————————-|————————|

Prune change

Details about prune changes in the spec

| CLI path for prune | Description of prune | Prune after build date | |——————–|———————-|————————|

Reporting options

Title: Reporting options URL: https://toolbox.watermint.org/guides/reporting-options.md —

Reporting options

The watermint toolbox creates reports from data obtained from services via the API. The reports differ depending on the command.

Commands that output data from the API as reports.
Commands that output data from the API as reports after processing.

The command output format is designed for core use cases. To avoid confusion, the command omits irrelevant/low priority fields. You can output the abbreviated data using the method shown below, or create a report with your preferred format by using output filter.

Hidden columns

In the CSV and xlsx reports produced by the command, some columns may be omitted. This includes, for example, internally used IDs and data of little relevance.

$ ./tbx dropbox file account info

watermint toolbox xxx.x.xxx
===========================

© 2016-2024 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.

| email                 | email_verified | given_name | surname | display_name |
|-----------------------|----------------|------------|---------|--------------|
| xxx@xxxxxxxxxxxxx.xxx | true           | xxxx       | xxxx    | xxxxxxxx     |

If you want to output this type of data, you can add the `-experiment report_all_columns’ option to output all defined columns.

$ ./tbx dropbox file account info -experiment report_all_columns

watermint toolbox xxx.x.xxx
===========================

© 2016-2024 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.

| team_member_id                            | email                 | email_verified | status | given_name | surname | familiar_name | display_name | abbreviated_name | member_folder_id | external_id | account_id                               | persistent_id | joined_on | invited_on | role | tag |
|-------------------------------------------|-----------------------|----------------|--------|------------|---------|---------------|--------------|------------------|------------------|-------------|------------------------------------------|---------------|-----------|------------|------|-----|
| dbmid:xxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | xxx@xxxxxxxxxxxxx.xxx | true           |        | xxxx       | xxxx    | xxxxxxxx      | xxxxxxx     | xxxx             |                  |             | dbid:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |               |           |            |      |     |

Even if you use this option, some information may not be output. If you need more detailed information, try the following output filters.

This feature allows you to filter the output of the command. This is useful if you want to process the output in a specific format.

NOTE: This filter is applied to all output reports. It will not work as intended for commands that output multiple report formats. When processing multiple report formats, please use the util json query command to process each of the output JSON files.

In addition, in some cases, data in JSON format contains more data. If you want to retrieve such hidden data, this option will help you to extract it as a report.

For example, the command dropbox team member list returns a list of team members. JSON report contains raw data from the Dropbox API. If you want to extract only the email address and the verification status of the team members, you can use the output filter option.

$ ./tbx dropbox team member list -output json --output-filter "[.profile.email, .profile.email_verified]"
["sugito@example.com", true]
["kajiwara@example.com", true]
["takimoto@example.com", false]
["ueno@example.com", true]
["tomioka@example.com", false]

Then, if you want to format this data as a CSV, you can use the @csv filter like this (adding | @csv at the end):

$ ./tbx dropbox team member list -output json --output-filter "[.profile.email, .profile.email_verified] | @csv"
"sugito@example.com",true
"kajiwara@example.com",true
"takimoto@example.com",false
"ueno@example.com",true
"tomioka@example.com",false

In case you want to test the output filter, you can run the command first without the output filter option. The command will generate the raw JSON output. Then, you can test the query the command util json query to test the query.

watermint toolbox - The multi-purpose utility command-line tool for web services

watermint toolbox, user manual

Common command options

Commands

license

Usage

version

Usage

Results

Report: versions

config auth delete

Usage

Options:

Results

Report: deleted

config auth list

Usage

Results

Report: entity

config feature disable

Usage

Options:

config feature enable

Usage

Options:

config feature list

Usage

config license install

Usage

Options:

config license list

Usage

Results

Report: keys

log api job

Usage

Options:

Results

Report: latencies

Report: population

Report: time_series

log api name

Usage

Options:

Results

Report: latencies

Report: population

Report: time_series

log cat curl

Usage

Options:

log cat job

Usage

Options:

log cat kind

Usage

Options:

log cat last

Usage

Options:

log job archive

Usage

Options:

log job delete

Usage

Options:

log job list

Usage

Options:

Results

Report: log

util archive unzip

Usage

Options:

util archive zip

Usage

Options:

util cert selfsigned

Usage

Options: