HFS 3

List files

GET

/~/api/get_file_list

Front-end

returns all files of a specified folder

Request

Query Params

uri

string

optional

path to the folder containing the files. Default is /

offset

number

optional

number of records to skip

limit

number

optional

max number of records to return

string

optional

search for files with the specified pattern, also in subfolders.

string

optional

request separated c and m properties in entries. Pass any string to turn it on. By default only m is provided, and when missing it is copied from c.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200all files accordingly to the specified parameters

application/json

Body

can_archive

boolean

optional

if you can download this folder as zip

can_upload

boolean

optional

if you can upload in this folder

can_delete

boolean

optional

if you can delete items in this folder

can_comment

boolean

optional

if you can coment items in this folder

list

array[object (DirEntry) {6}]

optional

entries from this folder

string

required

name of the entry. Can be a relative path in case you used search.

string <date-time>

optional

creation time

string <date-time>

optional

modification time

number

optional

size, in bytes

string

optional

permissions, only when are different from the parent folder.
Meaning of each character:

r: cannot be downloaded

R: can be downloaded only with other credentials

l: folder cannot be listed

L: folder can be listed only with other credetnials

d: can be deleted

Match pattern:

[rR]?[lL]?d?

comment

string

optional

assigned comment

Example

{
  "can_archive": true,
  "can_upload": true,
  "can_delete": true,
  "can_comment": true,
  "list": [
    {
      "n": "string",
      "c": "2019-08-24T14:15:22Z",
      "m": "2019-08-24T14:15:22Z",
      "s": 0,
      "p": "string",
      "comment": "string"
    }
  ]
}

Modified at 2024-05-11 06:42:13

Introduction

Upload