CUcuse-dev
filesystem

List Directory Contents

Changed on

Lists the contents of a directory with optional filtering.

post/api/filesystem/list

Request

  • Base URL
    http://localhost:4242/your-computer-name
  • URL
    http://localhost:4242/your-computer-name/api/filesystem/list
  • Auth
    none declared

Request body

pathstring required

Directory path to list

include_hiddenboolean

Whether to include hidden files/directories

patternstring nullable

Glob pattern to filter results

Example request

{
  "include_hidden": false,
  "path": "/home/user/documents",
  "pattern": "*.txt"
}

Response

Successfully listed directory contents

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"
  }
]

Changes