LICENSE

all content, endpoints, and code provided by this API are licensed under the GNU Affero General Public License v3 (AGPL-3.0).

By accessing or using this API, you agree to comply with the terms of the AGPLv3.

For more details, please read the full license at GNU AGPLv3.

List directory contents

POST

/api/fs/list

Get list of files and directories at specified path with pagination

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "path": "/",
    "password": "",
    "refresh": false,
    "page": 1,
    "per_page": 30
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/fs/list' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "path": "/",
    "password": "",
    "refresh": false,
    "page": 1,
    "per_page": 30
}'

Responses

🟢200成功

application/json

Directory listing retrieved successfully

Body

Example

{
    "code": 200,
    "message": "success",
    "data": {
        "content": [
            {
                "id": "",
                "path": "D:\\files\\document.pdf",
                "name": "document.pdf",
                "size": 1024000,
                "is_dir": false,
                "modified": "2025-10-20T15:30:00+08:00",
                "created": "2025-10-20T10:00:00+08:00",
                "sign": "YBgnmykwCXUstXvNGtECaz_12gseXSL03cpqh5rTcGA=:0",
                "thumb": "",
                "type": 4,
                "hashinfo": "null",
                "hash_info": null,
                "mount_details": {
                    "driver_name": "Local",
                    "total_space": 1000000000000,
                    "free_space": 500000000000
                }
            }
        ],
        "total": 14,
        "readme": "",
        "header": "",
        "write": true,
        "provider": "Local"
    }
}

🟠401未认证

🟠403权限不足

🟠404未找到

Modified at 2025-10-21 05:30:21

Get indexing progress (Admin)

Get file or directory info