Skip to main content
Skip table of contents

FileServerController

Last updated: 2025/3/7 11:40:50

Path To

Name

Description/Function

/api/file

/delete/{path}

Deletes the specified file.

/api/file

/delete/{dir1}/{filename}

Deletes the specified file.

/api/file

/delete/{dir1}/{dir2}/{filename}

Deletes the specified file.

/api/file

/delete/{dir1}/{dir2}/{dir3}/{filename}

Deletes the specified file.

/api/file

/delete/{dir1}/{dir2}/{dir3}/{dir4}/{filename}

Deletes the specified file.

/api/file

/delete/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{filename}

Deletes the specified file.

/api/file

/download/{filePath}

Downloads the specified file.

/api/file

/download/{dir1}/{fileName}

Download the specified file.

/api/file

/download/{dir1}/{dir2}/{fileName}

Download the specified file.

/api/file

/download/{dir1}/{dir2}/{dir3}/{fileName}

Download the specified file.

/api/file

/download/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

Download the specified file.

/api/file

/download/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

Download the specified file.

/api/file

/downloadfolderchunk/{chunkIndex}/{folderPath}

Downloads a chunk of a folder.

/api/file

/downloadfolderchunk/{chunkIndex}/{dir1}/{folderName}

Downloads the specified file.

/api/file

/downloadfolderchunk/{chunkIndex}/{dir1}/{dir2}/{folderName}

Downloads the specified file.

/api/file

/downloadfolder/{folderName}

Downloads the specified file.

/api/file

/downloadfolder/{dir1}/{folderName}

Downloads the specified file.

/api/file

/downloadfolder/{dir1}/{dir2}/{folderName}

Downloads the specified file.

/api/file

/downloadfolder/{dir1}/{dir2}/{dir3}/{folderName}

Downloads the specified file.

/api/file

/downloadfolder/{dir1}/{dir2}/{dir3}/{dir4}/{folderName}

Downloads the specified file.

/api/file

/downloadfolder/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{folderName}

Downloads the specified file.

/api/file

/downloadthumbnail/{dir1}/{fileName}

Download the specified thumbnail.

/api/file

/downloadthumbnail/{dir1}/{dir2}/{fileName}

Download the specified thumbnail.

/api/file

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{fileName}

Download the specified thumbnail.

/api/file

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

Download the specified thumbnail.

/api/file

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

Download the specified thumbnail.

/api/file

/downloadthumbnail/{fileName}

Downloads the specified thumbnail.

/api/file

/gallery

A gallery view of files in the root directory.

/api/file

/gallery/{dir1}

A gallery view of files in the directory depth 1.

/api/file

/gallery/{dir1}/{dir2}

A gallery view of files in the directory depth 2.

/api/file

/gallery/{dir1}/{dir2}/{dir3}

A gallery view of files in the directory depth 3.

/api/file

/gallery/{dir1}/{dir2}/{dir3}/{dir4}

A gallery view of files in the directory depth 4.

/api/file

/gallery/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

A gallery view of files in the directory depth 5.

/api/file

/getfileinfo

Get the specified file info.

/api/file

/list

List files in the root directory.

/api/file

/list/{dir1}

List files in the specified directory of depth 1.

/api/file

/list/{dir1}/{dir2}

List files in the specified directory of depth 2.

/api/file

/list/{dir1}/{dir2}/{dir3}

List files in the directory of depth 3.

/api/file

/list/{dir1}/{dir2}/{dir3}/{dir4}

List files in the directory of depth 4.

/api/file

/list/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

List files in the directory of depth 5.

/api/file

/wdelete/{path}

Deletes the specified file.

/api/file

/wdelete/{dir1}/{filename}

Deletes the specified file.

/api/file

/wdelete/{dir1}/{dir2}/{filename}

Deletes the specified file.

/api/file

/wdelete/{dir1}/{dir2}/{dir3}/{filename}

Deletes the specified file.

/api/file

/wdelete/{dir1}/{dir2}/{dir3}/{dir4}/{filename}

Deletes the specified file.

/api/file

/wdelete/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{filename}

Deletes the specified file.

/api/file

/wlist

List files in the root directory.

/api/file

/wlist/{dir1}

List files in the directory depth 1.

/api/file

/wlist/{dir1}/{dir2}

List files in the directory depth 2.

/api/file

/wlist/{dir1}/{dir2}/{dir3}

List files in the directory depth 3.

/api/file

/wlist/{dir1}/{dir2}/{dir3}/{dir4}

List files in the directory depth 4.

/api/file

/wlist/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

List files in the directory depth 5.

/delete/{path}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/delete/{path}

/delete/{dir1}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/delete/{dir1}/{filename}

/delete/{dir1}/{dir2}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/delete/{dir1}/{dir2}/{filename}

/delete/{dir1}/{dir2}/{dir3}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/delete/{dir1}/{dir2}/{dir3}/{filename}

/delete/{dir1}/{dir2}/{dir3}/{dir4}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/delete/{dir1}/{dir2}/{dir3}/{dir4}/{filename}

/delete/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/delete/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{filename}

/download/{filePath}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/download/{filePath}

/download/{dir1}/{fileName}

Function

Download the specified file.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/download/{dir1}/{fileName}

/download/{dir1}/{dir2}/{fileName}

Function

Download the specified file.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/download/{dir1}/{dir2}/{fileName}

/download/{dir1}/{dir2}/{dir3}/{fileName}

Function

Download the specified file.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/download/{dir1}/{dir2}/{dir3}/{fileName}

/download/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

Function

Download the specified file.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/download/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

/download/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

Function

Download the specified file.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/download/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

/downloadfolderchunk/{chunkIndex}/{folderPath}

Function

Downloads a chunk of a folder.

Method

Get

Response

A representing the asynchronous operation.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolderchunk/{chunkIndex}/{folderPath}

/downloadfolderchunk/{chunkIndex}/{dir1}/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolderchunk/{chunkIndex}/{dir1}/{folderName}

/downloadfolderchunk/{chunkIndex}/{dir1}/{dir2}/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolderchunk/{chunkIndex}/{dir1}/{dir2}/{folderName}

/downloadfolder/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolder/{folderName}

/downloadfolder/{dir1}/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolder/{dir1}/{folderName}

/downloadfolder/{dir1}/{dir2}/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolder/{dir1}/{dir2}/{folderName}

/downloadfolder/{dir1}/{dir2}/{dir3}/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolder/{dir1}/{dir2}/{dir3}/{folderName}

/downloadfolder/{dir1}/{dir2}/{dir3}/{dir4}/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolder/{dir1}/{dir2}/{dir3}/{dir4}/{folderName}

/downloadfolder/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{folderName}

Function

Downloads the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadfolder/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{folderName}

/downloadthumbnail/{dir1}/{fileName}

Function

Download the specified thumbnail.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadthumbnail/{dir1}/{fileName}

/downloadthumbnail/{dir1}/{dir2}/{fileName}

Function

Download the specified thumbnail.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadthumbnail/{dir1}/{dir2}/{fileName}

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{fileName}

Function

Download the specified thumbnail.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadthumbnail/{dir1}/{dir2}/{dir3}/{fileName}

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

Function

Download the specified thumbnail.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{fileName}

/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

Function

Download the specified thumbnail.

Method

Get

Response

True if the file file exists and was able to be retrieved.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadthumbnail/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{fileName}

/downloadthumbnail/{fileName}

Function

Downloads the specified thumbnail.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/downloadthumbnail/{fileName}

/gallery

Function

A gallery view of files in the root directory.

Method

Get

Response

Status code 200, for an completed operation being preformed.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/gallery

/gallery/{dir1}

Function

A gallery view of files in the directory depth 1.

Method

Get

Response

Directory 1.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/gallery/{dir1}

/gallery/{dir1}/{dir2}

Function

A gallery view of files in the directory depth 2.

Method

Get

Response

Directory 2.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/gallery/{dir1}/{dir2}

/gallery/{dir1}/{dir2}/{dir3}

Function

A gallery view of files in the directory depth 3.

Method

Get

Response

Directory 3.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/gallery/{dir1}/{dir2}/{dir3}

/gallery/{dir1}/{dir2}/{dir3}/{dir4}

Function

A gallery view of files in the directory depth 4.

Method

Get

Response

Directory 4.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/gallery/{dir1}/{dir2}/{dir3}/{dir4}

/gallery/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

Function

A gallery view of files in the directory depth 5.

Method

Get

Response

Directory 5.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/gallery/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

/getfileinfo

Function

Get the specified file info.

Method

Post

Body

CODE
{
    "Path" : "path/filename"
}

Response

A tuple containing the filename, last modified date time, and file size in bytes.

Explanation

Using the command:

CODE
http://<ip>:8080/api/still/take

Take an image and get the output path. Insert the path/filename into the POST template to get the file information.

The output would look like:

CODE
{
     "Item1": "20230802-222245.jpg",
     "Item2": "1601-01-02T19:28:22",
     "Item3": 5194046,
     "System.Runtime.CompilerServices.ITuple.Length": null,
     "System.Runtime.CompilerServices.ITuple.Item": null,
}
  • Item 1 = Filename

  • Item 2 = Date and time the file was created

  • Item 3 = Filename size

  • Item 4 = ? (Pending, request posted on RM-172)

  • Item 5 = ? (Pending, request posted on RM-172)

Example

Example 1

CODE
{
    "Path" : "/mnt/expand/64180671-0e95-4e34-9381-0780ce582c9c/DCIM/ProjectName-Still/20230802-222245.jpg"
}

Output

CODE
$ curl -X POST http://<ip>:<port>/api/files/getfileinfo
   -H 'Content-Type: application/json'
   -d '{ "Path" : "/mnt/expand/64180671-0e95-4e34-9381-0780ce582c9c/DCIM/ProjectName-Still/20230802-222245.jpg" }'

/list

Function

List files in the root directory.

Method

Get

Response

A list of the files in the specified directory.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/list

/list/{dir1}

Function

List files in the specified directory of depth 1.

Method

Get

Response

Directory 1.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/list/{dir1}

/list/{dir1}/{dir2}

Function

List files in the specified directory of depth 2.

Method

Get

Response

Directory 2.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/list/{dir1}/{dir2}

/list/{dir1}/{dir2}/{dir3}

Function

List files in the directory of depth 3.

Method

Get

Response

Directory 3.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/list/{dir1}/{dir2}/{dir3}

/list/{dir1}/{dir2}/{dir3}/{dir4}

Function

List files in the directory of depth 4.

Method

Get

Response

Directory 4.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/list/{dir1}/{dir2}/{dir3}/{dir4}

/list/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

Function

List files in the directory of depth 5.

Method

Get

Response

Directory 5.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/list/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

/wdelete/{path}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wdelete/{path}

/wdelete/{dir1}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wdelete/{dir1}/{filename}

/wdelete/{dir1}/{dir2}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wdelete/{dir1}/{dir2}/{filename}

/wdelete/{dir1}/{dir2}/{dir3}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wdelete/{dir1}/{dir2}/{dir3}/{filename}

/wdelete/{dir1}/{dir2}/{dir3}/{dir4}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wdelete/{dir1}/{dir2}/{dir3}/{dir4}/{filename}

/wdelete/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{filename}

Function

Deletes the specified file.

Method

Get

Response

True if the file exists and could be read.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wdelete/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}/{filename}

/wlist

Function

List files in the root directory.

Method

Get

Response

Status code 200, for an completed operation being preformed.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wlist

/wlist/{dir1}

Function

List files in the directory depth 1.

Method

Get

Response

Directory 1.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wlist/{dir1}

/wlist/{dir1}/{dir2}

Function

List files in the directory depth 2.

Method

Get

Response

Directory 2.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wlist/{dir1}/{dir2}

/wlist/{dir1}/{dir2}/{dir3}

Function

List files in the directory depth 3.

Method

Get

Response

Directory 3.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wlist/{dir1}/{dir2}/{dir3}

/wlist/{dir1}/{dir2}/{dir3}/{dir4}

Function

List files in the directory depth 4.

Method

Get

Response

Directory 4.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wlist/{dir1}/{dir2}/{dir3}/{dir4}

/wlist/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}

Function

List files in the directory depth 5.

Method

Get

Response

Directory 5.

Example

CODE
$ curl http://IP_ADDRESS:8080>/api/file/wlist/{dir1}/{dir2}/{dir3}/{dir4}/{dir5}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.