Synology Drive icon

Synology Drive

Synology Drive / FileStation operations

Search Files

AI-generated

Summary

Search for files in a specified Synology Drive folder path with client-side keyword filtering and optional recursion, returning file metadata matching the keyword.

Inputs

  • Path (required) — The folder path within Synology Drive to search, e.g., '/' for root.
  • Recursive — Set to true to search folders recursively; defaults to false.
  • Limit — Maximum number of files to retrieve from the server before filtering; defaults to 50.
  • Keyword — Case-insensitive keyword to filter file names client-side; optional.
  • Wait for Completion — Boolean flag (default false) to indicate whether to wait for a search job to complete, not used internally in this operation.
  • Poll Every (ms) — Interval in milliseconds to poll for completion if waiting; default 1200 ms, not internally used in this operation.
  • Poll Timeout (ms) — Maximum polling time in milliseconds; default 30000 ms, not used in this operation.
  • Extra Params (JSON) — Additional optional parameters as JSON to include in the API call.

Output shape

a single JSON object containing a success flag and a data object with all retrieved files matching the local keyword filter, total files retrieved before filtering, matched count, and keyword used

The operation uses the Synology FileStation List API to retrieve files limited by the specified 'limit' parameter and filters results locally by the 'keyword'. The 'waitForCompletion', 'pollIntervalMs', and 'pollTimeoutMs' parameters are present but not utilized internally by this operation. Results include metadata for each matching file.

Examples

Example 1: Search files recursively in folder '/Documents' with keyword 'report' and limit 100

Set Path to '/Documents', Recursive to true, Keyword to 'report', Limit to 100.

Links

Discussion