Synology Drive icon

Synology Drive

Synology Drive / FileStation operations

List Files

AI-generated

Summary

List files and folders from a specified path on Synology Drive, with options to control recursion, pagination, filtering, and additional API parameters.

Inputs

  • Path — The folder path to list files from, defaulting to root ('/').
  • Recursive — Whether to recursively include files from subfolders (default: false).
  • Offset — Pagination offset to start listing from (default: 0).
  • Limit — Maximum number of items to fetch per page when paginating (default: 50).
  • Return All — Choose to retrieve all files matching criteria by automatic pagination (default: false).
  • Include — Filter listing to include files and folders, files only, or folders only (default: both).
  • Extra Params (JSON) — Additional optional parameters as a JSON object to be passed directly to the Synology API call.

Output shape

An object containing a 'files' array listing the files/folders matching the query, along with metadata like total count and offset.

If 'Return All' is false, returns a single page of files with pagination controlled by 'Offset' and 'Limit'. If true, performs up to 200 paginated requests to accumulate all files. The 'files' array respects the 'Include' filter. Errors are thrown on API failure.

Links

Discussion