v1

latestOpenAPI 3.1.02026-07-13372867.8 KB

filesystem

Search Files

Searches for files matching a pattern in a directory tree.

post/api/filesystem/search

Request body

root_pathstring required

Root directory to start search from

patternstring required

Glob pattern to search for

max_resultsinteger

Maximum number of results to return

include_hiddenboolean

Whether to include hidden files/directories

Example request

{
  "include_hidden": false,
  "max_results": 100,
  "pattern": "*.txt",
  "root_path": "/home/user"
}

Response

Successfully searched for files

namestring required

File or directory name

pathstring required

Full path to the file or directory

typestring required

Type of entry: 'file' or 'directory'

sizeinteger required

Size in bytes

modified_timestring date-time required

Last modification time

is_hiddenboolean required

Whether the file/directory is hidden

extensionstring nullable

File extension if applicable

Example response

[
  {
    "extension": "txt",
    "is_hidden": false,
    "modified_time": "2024-03-10T12:34:56",
    "name": "document.txt",
    "path": "/home/user/documents/document.txt",
    "size": 1024,
    "type": "file"
  }
]