List all shared folders on the NAS. This is the starting point for file navigation — call this first to discover available paths. Shows each share's volume and that volume's free space (shared by every share on it); for how much space a share uses, call get_dir_size.

List files and folders in a directory. Supports glob pattern filtering, file type filtering, sorting, and pagination.

List the contents of a shared folder's recycle bin. Shows recently deleted files that can be restored.

Search recursively for files by keyword, extension, size, or modification date. The pattern parameter is a keyword/substring match on filenames (not glob). Use extension for file type filtering (e.g., extension="mkv"). Accepts human-readable sizes like "500MiB". mtime_from / mtime_to accept ISO 8601 ("2026-04-01T12:00:00+00:00"), a calendar date ("YYYY-MM-DD"), or Unix epoch seconds; naive dates are treated as UTC. For directory contents or sizes, use list_files or get_dir_size instead.

Get detailed metadata for specific files or folders: size, owner, timestamps, permissions, and real path. additional optionally picks the DSM fields to fetch: real_path, size, owner, time, perm, type (the file's extension type) and mount_point_type (shown only for a mount point). Default: real_path, size, owner, time, perm. Unknown values are rejected.

Calculate the total size of a directory, including all files and subdirectories. Returns total size, file count, and directory count. This is the best tool for answering 'how much space does X use' questions.

Download a NAS file to a local directory on this machine. Provide the NAS file path. dest_folder is optional if default_download_dir is configured. Does not overwrite existing local files by default.

Create one or more new folders. Creates parent directories automatically by default. Idempotent — creating an existing folder succeeds.

Rename a file or folder. Provide the full current path and the new name (just the name, not a full path).

Copy files or folders to a destination folder. Source files remain in place. Set overwrite=true to replace existing files.

Move files or folders to a new location. Source files are REMOVED after transfer. Set overwrite=true to replace existing files.

Delete files or folders. If the share has a recycle bin, files can be recovered. Otherwise deletion is permanent, as is deleting inside //#recycle.

Upload a local file from this machine to a NAS folder. Provide the local file path. dest_folder is optional if default_upload_dir is configured. Does not overwrite existing NAS files by default.

Restore deleted files from a shared folder's recycle bin to their original location or a specified destination.

List download tasks in the Download Station queue. Filter by status (downloading/finished/paused/error/all). Returns a table with id, title, type (bt/http/ftp/nzb), status, size, progress%, download and upload speed, ETA, and completion time. Paged with offset/limit (default 25); the footer gives the true total and the next offset. sort_by: queue (default, oldest first), created or completed (newest first; e.g. sort_by=completed, limit=1 gives the most recently finished task). A status filter or sort covers the whole queue, not just one page. Accounts that are not Download Station managers see only their own tasks (the output says so), so an empty list does not mean the NAS is idle.

Get detailed information for a specific download task: detail (status, destination, URI), transfer (size downloaded/uploaded, speed, peers), files (per-file selection for BT), trackers (BT only), peers (BT only). Use list_downloads first to find the task_id.

Get current Download Station throughput statistics: total download and upload speed across all tasks, plus eMule download/upload speed when the eMule service is enabled. For per-task speeds use list_downloads.

Get Download Station global configuration: default destination, BT/HTTP/FTP/NZB/eMule max speeds, eMule and auto-unzip state. For accounts that are not Download Station managers DSM returns a per-user view (labeled as such), not the NAS-wide settings. Use get_schedule for the weekly plan.

Get the Download Station schedule: whether it is enabled, the limited-speed (alt) download/upload rates, and the weekly plan as a 7-day × 24-hour grid where each hour is full speed, limited, or no download. The weekly plan needs a Download Station manager/admin account; otherwise only the flags are shown.

Create one or more download tasks. Pass a comma-separated list of URIs (HTTP, FTP, magnet, etc.) via uri OR pass a local path to a .torrent / .nzb file via torrent_file_path. destination is a share-relative path (omit to use your default destination; a non-manager who has none must set it first with set_download_config, because DS won't start their tasks until then). username / password may be supplied for protected URLs (not for torrent files). Returns the new task IDs when DSM provides them (not for URLs with username / password); long magnet links and URI lists are supported.

Remove one or more download tasks. task_ids is a list. A deleted task can't be restored (its source URL is gone with it), so name the tasks and confirm with the user before deleting. Files from finished tasks are always kept. For unfinished tasks the partial data is discarded (irreversible). force_complete asks DSM to keep the incomplete file in the destination instead, but DSM has been seen to discard it anyway, so don't rely on it to preserve partial data. DSM refuses force_complete on finished tasks (error 405; the task stays listed), so leave it false for those.

Pause one or more download tasks. task_ids is a list. An already-paused or finished task is refused for that id (error 405), while the others are paused. If none of the ids can be paused, the whole call fails with invalid_parameter.

Resume one or more paused download tasks. task_ids is a list. An active or finished task is refused for that id (error 405), while the others are resumed.

Edit task parameters. task_ids is a list. Currently supports destination (change the task's output share). Requires a newer Download Station (Task API v2); older versions get a clear error.

Set Download Station global configuration. All parameters are optional — only fields you pass get updated. Rates are KB/s; 0 means unlimited. Pass default_destination to change DS's default destination share. The rate fields require a Download Station manager/admin account: DSM silently ignores them from other accounts, so the tool refuses them. Any user can set default_destination: DSM applies it per user, and DS won't start a non-manager's tasks until it is set.

Set the Download Station schedule. All parameters optional — only what you pass gets updated. enabled / emule_enabled toggle whether the schedule applies (DSM lets any Download Station user toggle this NAS-wide flag). schedule_plan is a 168-character string, 24 chars per day, Sun first through Sat; each char is '0' no download, '1' full speed, '2' limited. download_rate / upload_rate set the limited speed in KB/s (0 = unlimited). The plan and rates need a Download Station manager/admin account; if that write is refused, nothing is applied.

Get NAS hardware and software info: model, firmware, CPU, RAM, temperature, uptime. Use this to identify the NAS and check its basic health.

Get live resource utilization: CPU load, memory usage, disk I/O, and network throughput. Use this to check if the NAS is under heavy load before running expensive operations like search or large file copies.