https://github.com/sachinsenal0x64/alist-api
📁 Alist V3 API Docs
https://github.com/sachinsenal0x64/alist-api
alist
Last synced: 5 months ago
JSON representation
📁 Alist V3 API Docs
- Host: GitHub
- URL: https://github.com/sachinsenal0x64/alist-api
- Owner: sachinsenal0x64
- License: mit
- Created: 2023-09-02T10:29:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-08T15:42:07.000Z (almost 3 years ago)
- Last Synced: 2025-08-12T01:29:25.676Z (11 months ago)
- Topics: alist
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
title: 个人项目 v1.0.0
language_tabs:
- shell: Shell
- http: HTTP
- javascript: JavaScript
- ruby: Ruby
- python: Python
- php: PHP
- java: Java
- go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: "@tarslib/widdershins v4.0.17"
---
# 个人项目
> v1.0.0
Base URLs:
# alist/auth
## POST token获取
POST /api/auth/login
获取某个用户的临时JWt token
> Body 请求参数
```json
{
"username": "{{alist_username}}",
"password": "{{alist_password}}"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|body|body|object| 否 ||none|
|» username|body|string| 是 | 用户名|用户名|
|» password|body|string| 是 | 密码|密码|
|» otp_code|body|string| 是 | 二步验证码|二步验证码|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"token": "abcd"
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none||状态码|
|» message|string|true|none||信息|
|» data|object|true|none||data|
|»» token|string|true|none||token|
## POST token获取hash
POST /api/auth/login/hash
获取某个用户的临时JWt token，传入的密码需要在添加-https://github.com/alist-org/alist后缀后再进行sha256
> Body 请求参数
```json
{
"username": "{{alist_username}}",
"password": "{{alist_password}}"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|body|body|object| 否 ||none|
|» username|body|string| 是 | 用户名|用户名|
|» password|body|string| 是 | 密码|hash后密码，获取方式为`sha256(密码-https://github.com/alist-org/alist)`|
|» otp_code|body|string| 是 | 二步验证码|二步验证码|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"token": "abcd"
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none||状态码|
|» message|string|true|none||信息|
|» data|object|true|none||data|
|»» token|string|true|none||token|
## POST 生成2FA密钥
POST /api/auth/2fa/generate
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"qr": "data:image/png;base64,iVBORw0KGgoAAAANSUhE",
"secret": "RPQZG4MDS3"
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none|数据|none|
|»» qr|string|true|none|二维码|二维码图片的data url|
|»» secret|string|true|none|密钥|none|
## POST 验证2FA code
POST /api/auth/2fa/verify
> Body 请求参数
```json
{
"code": "string",
"secret": "string"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» code|body|string| 是 | 2FA验证码|none|
|» secret|body|string| 是 | 2FA密钥|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## GET 获取当前用户信息
GET /api/me
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 否 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"id": 1,
"username": "admin",
"Salt": "EV1R",
"password": "",
"base_path": "/",
"role": 2,
"disabled": false,
"permission": 0,
"sso_id": "",
"otp": true
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none|数据|none|
|»» id|integer|true|none|id|none|
|»» username|string|true|none|用户名|none|
|»» Salt|string|true|none|salt|none|
|»» password|string|true|none|密码|none|
|»» base_path|string|true|none|根目录|none|
|»» role|integer|true|none|角色|none|
|»» disabled|boolean|true|none|是否禁用|none|
|»» permission|integer|true|none|权限|none|
|»» sso_id|string|true|none|sso id|none|
|»» otp|boolean|true|none|是否开启二步验证|none|
# alist/fs
## POST 新建文件夹
POST /api/fs/mkdir
> Body 请求参数
```json
{
"path": "/tt"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||token|
|Content-Type|header|string| 否 ||none|
|body|body|object| 否 ||none|
|» path|body|string| 是 | 新目录路径|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 重命名文件
POST /api/fs/rename
> Body 请求参数
```json
{
"name": "test3",
"path": "/阿里云盘/test2"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||token|
|Content-Type|header|string| 否 ||none|
|body|body|object| 否 ||none|
|» name|body|string| 是 | 目标文件名，不支持'/'|none|
|» path|body|string| 是 | 源文件名|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## PUT 表单上传文件
PUT /api/fs/form
> Body 请求参数
```yaml
file: []
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||token|
|Content-Type|header|string| 是 ||需要是multipart/form-data;|
|Content-Length|header|string| 是 ||文件大小|
|File-Path|header|string| 是 ||经过URL编码的完整文件路径|
|As-Task|header|string| 否 ||是否添加为任务|
|body|body|object| 否 ||none|
|» file|body|string(binary)| 是 ||文件|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 列出文件目录
POST /api/fs/list
> Body 请求参数
```json
{
"path": "/t",
"password": "",
"page": 1,
"per_page": 0,
"refresh": false
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» path|body|string| 否 | 路径|none|
|» password|body|string| 否 | 密码|none|
|» page|body|integer| 否 | 页数|none|
|» per_page|body|integer| 否 | 每页数目|none|
|» refresh|body|boolean| 否 | 是否强制刷新|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"content": [
{
"name": "m",
"size": 0,
"is_dir": true,
"modified": "2023-07-19T09:48:13.695585868+08:00",
"sign": "",
"thumb": "",
"type": 1
}
],
"total": 1,
"readme": "",
"write": true,
"provider": "unknown"
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none||none|
|»» content|[object]|true|none|内容|none|
|»»» name|string|true|none|文件名|none|
|»»» size|integer|true|none|大小|none|
|»»» is_dir|boolean|true|none|是否是文件夹|none|
|»»» modified|string|true|none|修改时间|none|
|»»» sign|string|true|none|签名|none|
|»»» thumb|string|true|none|缩略图|none|
|»»» type|integer|true|none|类型|none|
|»» total|integer|true|none|总数|none|
|»» readme|string|true|none|说明|none|
|»» write|boolean|true|none|是否可写入|none|
|»» provider|string|true|none||none|
## POST 获取某个文件/目录信息
POST /api/fs/get
> Body 请求参数
```json
{
"path": "/t",
"password": "",
"page": 1,
"per_page": 0,
"refresh": false
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» path|body|string| 否 | 路径|none|
|» password|body|string| 否 | 密码|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"name": "root",
"size": 0,
"is_dir": true,
"modified": "0001-01-01T00:00:00Z",
"sign": "",
"thumb": "",
"type": 0,
"raw_url": "",
"readme": "",
"provider": "unknown",
"related": null
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none||none|
|»» name|string|true|none|文件名|none|
|»» size|integer|true|none|大小|none|
|»» is_dir|boolean|true|none|是否是文件夹|none|
|»» modified|string|true|none|修改时间|none|
|»» sign|string|true|none|签名|none|
|»» thumb|string|true|none|缩略图|none|
|»» type|integer|true|none|类型|none|
|»» raw_url|string|true|none|原始url|none|
|»» readme|string|true|none|说明|none|
|»» provider|string|true|none||none|
|»» related|null|true|none||none|
## POST 搜索文件或文件夹
POST /api/fs/search
> Body 请求参数
```json
{
"parent": "string",
"keywords": "string",
"scope": 0,
"page": 0,
"per_page": 0,
"password": "string"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» parent|body|string| 是 | 搜索目录|none|
|» keywords|body|string| 是 | 关键词|none|
|» scope|body|integer| 是 | 搜索类型|0-全部 1-文件夹 2-文件|
|» page|body|integer| 是 | 页数|none|
|» per_page|body|integer| 是 | 每页数目|none|
|» password|body|string| 是 | 密码|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"content": [
{
"parent": "/m",
"name": "4305da1e",
"is_dir": false,
"size": 393090,
"type": 0
}
],
"total": 1
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none||none|
|»» content|[object]|true|none||none|
|»»» parent|string|true|none|路径|none|
|»»» name|string|true|none|文件名|none|
|»»» is_dir|boolean|true|none|是否是文件夹|none|
|»»» size|integer|true|none|大小|none|
|»»» type|integer|true|none|类型|none|
|»» total|integer|true|none|总数|none|
## POST 获取目录
POST /api/fs/dirs
> Body 请求参数
```json
{
"path": "/t",
"password": "",
"page": 1,
"per_page": 0,
"refresh": false
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» path|body|string| 否 | 路径|none|
|» password|body|string| 否 | 密码|none|
|» force_root|body|boolean| 否 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": [
{
"name": "a",
"modified": "2023-07-19T09:48:13.695585868+08:00"
}
]
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|[object]|true|none||none|
|»» name|string|true|none|文件名|none|
|»» modified|string|true|none|修改时间|none|
## POST 批量重命名
POST /api/fs/batch_rename
> Body 请求参数
```json
{
"src_dir": "/m2",
"rename_objects": [
{
"src_name": "test.txt",
"new_name": "aaas2.txt"
}
]
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||token|
|Content-Type|header|string| 否 ||none|
|body|body|object| 否 ||none|
|» src_dir|body|string| 是 | 源目录|none|
|» rename_objects|body|[object]| 是 ||none|
|»» src_name|body|string| 否 | 原文件名|none|
|»» new_name|body|string| 否 | 新文件名|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|状态码|
|» message|string|true|none|信息|信息|
|» data|null|true|none||none|
## POST 正则重命名
POST /api/fs/regex_rename
> Body 请求参数
```json
{
"src_dir": "/m2",
"rename_objects": [
{
"src_name": "test.txt",
"new_name": "aaas2.txt"
}
]
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||token|
|Content-Type|header|string| 否 ||none|
|body|body|object| 否 ||none|
|» src_dir|body|string| 是 | 源目录|none|
|» src_name_regex|body|string| 是 | 源文件匹配正则|none|
|» new_name_regex|body|string| 是 | 新文件名正则|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|状态码|
|» message|string|true|none|信息|信息|
|» data|null|true|none||none|
## POST 移动文件
POST /api/fs/move
> Body 请求参数
```json
{
"src_dir": "string",
"dst_dir": "string",
"names": [
"string"
]
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» src_dir|body|string| 是 | 源文件夹|none|
|» dst_dir|body|string| 是 | 目标文件夹|none|
|» names|body|[string]| 是 | 文件名|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 聚合移动
POST /api/fs/recursive_move
> Body 请求参数
```json
{
"src_dir": "string",
"dst_dir": "string"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» src_dir|body|string| 是 | 源文件夹|none|
|» dst_dir|body|string| 是 | 目标文件夹|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 复制文件
POST /api/fs/copy
> Body 请求参数
```json
{
"src_dir": "string",
"dst_dir": "string",
"names": [
"string"
]
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» src_dir|body|string| 是 | 源文件夹|none|
|» dst_dir|body|string| 是 | 目标文件夹|none|
|» names|body|[string]| 是 | 文件名|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 删除文件或文件夹
POST /api/fs/remove
> Body 请求参数
```json
{
"names": [
"string"
],
"dir": "string"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» names|body|[string]| 是 | 文件名|none|
|» dir|body|string| 是 | 目录|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 删除空文件夹
POST /api/fs/remove_empty_directory
> Body 请求参数
```json
{
"src_dir": "string"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» src_dir|body|string| 是 | 目录|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## PUT 流式上传文件
PUT /api/fs/put
> Body 请求参数
```yaml
string
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|File-Path|header|string| 是 ||经过URL编码的完整目标文件路径|
|As-Task|header|string| 否 ||是否添加为任务|
|Content-Type|header|string| 是 ||none|
|Content-Length|header|string| 是 ||none|
|body|body|string(binary)| 否 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 添加aria2下载
POST /api/fs/add_aria2
> Body 请求参数
```json
{
"urls": [
"string"
],
"path": "string"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» urls|body|[string]| 是 | url|none|
|» path|body|string| 是 | 目标路径|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 添加qBittorrent下载
POST /api/fs/add_qbit
> Body 请求参数
```json
{
"urls": [
"string"
],
"path": "string"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» urls|body|[string]| 是 | url|none|
|» path|body|string| 是 | 目标路径|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
# alist/public
## GET ping检测
GET /ping
连通性ping检测
> 返回示例
> 成功
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
## GET 获取站点设置
GET /api/public/settings
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"allow_indexed": "false",
"allow_mounted": "false",
"announcement": "",
"audio_autoplay": "true",
"audio_cover": "https://jsd.nn.ci/gh/alist-org/logo@main/logo.svg",
"auto_update_index": "false",
"default_page_size": "30",
"external_previews": "{}",
"favicon": "https://cdn.jsdelivr.net/gh/alist-org/logo@main/logo.svg",
"filename_char_mapping": "{\"/\": \"|\"}",
"forward_direct_link_params": "false",
"hide_files": "/\\/README.md/i",
"home_container": "hope_container",
"home_icon": "🏠",
"iframe_previews": "{\n\t\"doc,docx,xls,xlsx,ppt,pptx\": {\n\t\t\"Microsoft\":\"https://view.officeapps.live.com/op/view.aspx?src=$e_url\",\n\t\t\"Google\":\"https://docs.google.com/gview?url=$e_url&embedded=true\"\n\t},\n\t\"pdf\": {\n\t\t\"PDF.js\":\"https://alist-org.github.io/pdf.js/web/viewer.html?file=$e_url\"\n\t},\n\t\"epub\": {\n\t\t\"EPUB.js\":\"https://alist-org.github.io/static/epub.js/viewer.html?url=$e_url\"\n\t}\n}",
"logo": "https://cdn.jsdelivr.net/gh/alist-org/logo@main/logo.svg",
"main_color": "#1890ff",
"ocr_api": "https://api.nn.ci/ocr/file/json",
"package_download": "true",
"pagination_type": "all",
"robots_txt": "User-agent: *\nAllow: /",
"search_index": "none",
"settings_layout": "responsive",
"site_title": "AList",
"sso_login_enabled": "false",
"sso_login_platform": "",
"version": "v3.25.1",
"video_autoplay": "true"
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none|数据|none|
|»» allow_indexed|string|true|none|允许索引|none|
|»» allow_mounted|string|true|none|允许挂载|none|
|»» announcement|string|true|none|公告|none|
|»» audio_autoplay|string|true|none|自动播放音频|none|
|»» audio_cover|string|true|none|音频封面|none|
|»» auto_update_index|string|true|none|自动更新索引|none|
|»» default_page_size|string|true|none|默认分页数|none|
|»» external_previews|string|true|none|外部预览|none|
|»» favicon|string|true|none|网站图标|none|
|»» filename_char_mapping|string|true|none||none|
|»» forward_direct_link_params|string|true|none||none|
|»» hide_files|string|true|none|隐藏文件|none|
|»» home_container|string|true|none|主页容器|none|
|»» home_icon|string|true|none|主页图标|none|
|»» iframe_previews|string|true|none|iframe预览设置|none|
|»» logo|string|true|none|logo|none|
|»» main_color|string|true|none|主题颜色|none|
|»» ocr_api|string|true|none|pcr接口|none|
|»» package_download|string|true|none|打包下载|none|
|»» pagination_type|string|true|none||none|
|»» robots_txt|string|true|none|robots文件|none|
|»» search_index|string|true|none||none|
|»» settings_layout|string|true|none||none|
|»» site_title|string|true|none|站点标题|none|
|»» sso_login_enabled|string|true|none|启用sso登录|none|
|»» sso_login_platform|string|true|none|sso登录平台|none|
|»» version|string|true|none|版本|none|
|»» video_autoplay|string|true|none|视频自动播放|none|
# alist/admin/meta
## GET 列出元信息
GET /api/admin/meta/list
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|page|query|string| 否 ||页数|
|per_page|query|string| 否 ||每页个数|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"content": [
{
"id": 1,
"path": "/a",
"password": "i",
"p_sub": false,
"write": false,
"w_sub": false,
"hide": "",
"h_sub": false,
"readme": "",
"r_sub": false
}
],
"total": 1
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none|数据|none|
|»» content|[object]|true|none|内容|none|
|»»» id|integer|false|none|id|none|
|»»» path|string|false|none|路径|none|
|»»» password|string|false|none|密码|none|
|»»» p_sub|boolean|false|none|密码是否应用到子文件夹|none|
|»»» write|boolean|false|none|是否允许写入|none|
|»»» w_sub|boolean|false|none|是否允许写入引用到子文件夹|none|
|»»» hide|string|false|none|隐藏|none|
|»»» h_sub|boolean|false|none|隐藏是否应用到子文件夹|none|
|»»» readme|string|false|none|说明|none|
|»»» r_sub|boolean|false|none|说明是否应用到子文件夹|none|
|»» total|integer|true|none|总数|none|
## GET 获取元信息
GET /api/admin/meta/get
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 是 ||元信息id|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"id": 1,
"path": "/a",
"password": "c",
"p_sub": false,
"write": false,
"w_sub": false,
"hide": "",
"h_sub": false,
"readme": "",
"r_sub": false
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none||none|
|»» id|integer|true|none|id|none|
|»» path|string|true|none|路径|none|
|»» password|string|true|none|密码|none|
|»» p_sub|boolean|true|none|密码是否应用到子文件夹|none|
|»» write|boolean|true|none|开启写入|none|
|»» w_sub|boolean|true|none|开启写入是否应用到子文件夹|none|
|»» hide|string|true|none|隐藏|none|
|»» h_sub|boolean|true|none|隐藏是否应用到子文件夹|none|
|»» readme|string|true|none|说明|none|
|»» r_sub|boolean|true|none|说明是否应用到子文件夹|none|
## POST 新增元信息
POST /api/admin/meta/create
> Body 请求参数
```json
{
"id": 0,
"path": "/a",
"password": "c",
"p_sub": false,
"write": false,
"w_sub": false,
"hide": "",
"h_sub": false,
"readme": "",
"r_sub": false
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» id|body|integer| 是 | id|none|
|» path|body|string| 是 | 路径|none|
|» password|body|string| 是 | 密码|none|
|» p_sub|body|boolean| 是 | 密码是否应用到子文件夹|none|
|» write|body|boolean| 是 | 开启写入|none|
|» w_sub|body|boolean| 是 | 开启写入是否应用到子文件夹|none|
|» hide|body|string| 是 | 隐藏|none|
|» h_sub|body|boolean| 是 | 隐藏是否应用到子文件夹|none|
|» readme|body|string| 是 | 说明|none|
|» r_sub|body|boolean| 是 | 说明是否应用到子文件夹|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none||none|
|» message|string|true|none||none|
|» data|null|true|none||none|
## POST 更新元信息
POST /api/admin/meta/update
> Body 请求参数
```json
{
"id": 0,
"path": "/a",
"password": "c",
"p_sub": false,
"write": false,
"w_sub": false,
"hide": "",
"h_sub": false,
"readme": "",
"r_sub": false
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» id|body|integer| 是 | id|none|
|» path|body|string| 是 | 路径|none|
|» password|body|string| 是 | 密码|none|
|» p_sub|body|boolean| 是 | 密码是否应用到子文件夹|none|
|» write|body|boolean| 是 | 开启写入|none|
|» w_sub|body|boolean| 是 | 开启写入是否应用到子文件夹|none|
|» hide|body|string| 是 | 隐藏|none|
|» h_sub|body|boolean| 是 | 隐藏是否应用到子文件夹|none|
|» readme|body|string| 是 | 说明|none|
|» r_sub|body|boolean| 是 | 说明是否应用到子文件夹|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none||none|
|» message|string|true|none||none|
|» data|null|true|none||none|
## POST 删除元信息
POST /api/admin/meta/delete
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 是 ||none|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
# alist/admin/user
## GET 列出所有用户
GET /api/admin/user/list
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"content": [
{
"id": 1,
"username": "admin",
"Salt": "W",
"password": "",
"base_path": "/",
"role": 2,
"disabled": false,
"permission": 0,
"sso_id": ""
},
{
"id": 2,
"username": "guest",
"Salt": "M",
"password": "",
"base_path": "/",
"role": 1,
"disabled": true,
"permission": 0,
"sso_id": ""
},
{
"id": 3,
"username": "N",
"Salt": "L",
"password": "",
"base_path": "/",
"role": 0,
"disabled": false,
"permission": 256,
"sso_id": ""
}
],
"total": 3
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none||none|
|»» content|[object]|true|none||none|
|»»» id|integer|true|none|id|none|
|»»» username|string|true|none|用户名|none|
|»»» Salt|string|true|none|salt|none|
|»»» password|string|true|none|密码|none|
|»»» base_path|string|true|none|基本路径|none|
|»»» role|integer|true|none|角色|none|
|»»» disabled|boolean|true|none|是否禁用|none|
|»»» permission|integer|true|none|权限|none|
|»»» sso_id|string|true|none|sso id|none|
|»» total|integer|true|none|总数|none|
## GET 列出某个用户
GET /api/admin/user/get
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 是 ||none|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"id": 1,
"username": "admin",
"Salt": "s",
"password": "",
"base_path": "/",
"role": 2,
"disabled": false,
"permission": 0,
"sso_id": ""
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none||none|
|»» content|[object]|true|none||none|
|»»» id|integer|true|none|id|none|
|»»» username|string|true|none|用户名|none|
|»»» Salt|string|true|none|salt|none|
|»»» password|string|true|none|密码|none|
|»»» base_path|string|true|none|基本路径|none|
|»»» role|integer|true|none|角色|none|
|»»» disabled|boolean|true|none|是否禁用|none|
|»»» permission|integer|true|none|权限|none|
|»»» sso_id|string|true|none|sso id|none|
|»» total|integer|true|none|总数|none|
## POST 新建用户
POST /api/admin/user/create
> Body 请求参数
```json
{
"id": 0,
"username": "a",
"password": "123456",
"base_path": "/",
"role": 0,
"permission": 60,
"disabled": false,
"sso_id": ""
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» id|body|integer| 否 | id|none|
|» username|body|string| 是 | 用户名|none|
|» password|body|string| 否 | 密码|none|
|» base_path|body|string| 否 | 基本路径|none|
|» role|body|integer| 否 | 角色|none|
|» permission|body|integer| 否 | 权限|none|
|» disabled|body|boolean| 否 | 是否禁用|none|
|» sso_id|body|string| 否 | sso id|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 更新用户信息
POST /api/admin/user/update
> Body 请求参数
```json
{
"id": 0,
"username": "a",
"password": "123456",
"base_path": "/",
"role": 0,
"permission": 60,
"disabled": false,
"sso_id": ""
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
|body|body|object| 否 ||none|
|» id|body|integer| 是 | id|none|
|» username|body|string| 是 | 用户名|none|
|» password|body|string| 否 | 密码|none|
|» base_path|body|string| 否 | 基本路径|none|
|» role|body|integer| 否 | 角色|none|
|» permission|body|integer| 否 | 权限|none|
|» disabled|body|boolean| 否 | 是否禁用|none|
|» sso_id|body|string| 否 | sso id|none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 取消某个用户的两步验证
POST /api/admin/user/cancel_2fa
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 是 ||none|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 删除用户
POST /api/admin/user/delete
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 是 ||none|
|Authorization|header|string| 否 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
## POST 删除用户缓存
POST /api/admin/user/del_cache
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|username|query|string| 是 ||none|
|Authorization|header|string| 否 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
# alist/admin/storage
## GET 列出存储列表
GET /api/admin/storage/list
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|page|query|string| 否 ||页数|
|per_page|query|string| 否 ||每页数目|
|Authorization|header|string| 是 ||token|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"content": [
{
"id": 1,
"mount_path": "/lll",
"order": 0,
"driver": "Local",
"cache_expiration": 0,
"status": "work",
"addition": "{\"root_folder_path\":\"/root/www\",\"thumbnail\":false,\"thumb_cache_folder\":\"\",\"show_hidden\":true,\"mkdir_perm\":\"777\"}",
"remark": "",
"modified": "2023-07-19T09:46:38.868739912+08:00",
"disabled": false,
"enable_sign": false,
"order_by": "name",
"order_direction": "asc",
"extract_folder": "front",
"web_proxy": false,
"webdav_policy": "native_proxy",
"down_proxy_url": ""
}
],
"total": 5
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|状态码|
|» message|string|true|none|信息|信息|
|» data|object|true|none||none|
|»» content|[object]|true|none||none|
|»»» id|integer|false|none|id|id|
|»»» mount_path|string|false|none|挂载路径|挂载路径|
|»»» order|integer|false|none|排序|顺序|
|»»» driver|string|false|none|驱动|驱动类型|
|»»» cache_expiration|integer|false|none|缓存过期时间|缓存时间|
|»»» status|string|false|none|状态|状态|
|»»» addition|string|false|none|额外信息|额外信息|
|»»» remark|string|false|none|备注|备注名|
|»»» modified|string|false|none|修改时间|修改时间|
|»»» disabled|boolean|false|none|禁用|是否被禁用|
|»»» enable_sign|boolean|false|none|启用签名|none|
|»»» order_by|string|false|none|排序|排序方式|
|»»» order_direction|string|false|none|排序方向|排序方向|
|»»» extract_folder|string|false|none|提取文件夹|提取目录顺序|
|»»» web_proxy|boolean|false|none|web代理|http代理|
|»»» webdav_policy|string|false|none|webdav代理|webdav策略|
|»»» down_proxy_url|string|false|none|下载代理url|下载代理url|
|»» total|integer|true|none|总数|none|
## POST 启用存储
POST /api/admin/storage/enable
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|integer| 是 ||存储id|
|Authorization|header|string| 是 ||token|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|状态码|
|» message|string|true|none|信息|信息|
|» data|null|true|none|data|data|
## POST 禁用存储
POST /api/admin/storage/disable
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 是 ||存储id|
|Authorization|header|string| 是 ||token|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|状态码|
|» message|string|true|none|信息|信息|
|» data|null|true|none|data|data|
## POST 更新存储
POST /api/admin/storage/create
> Body 请求参数
```json
{
"mount_path": "/lll",
"order": 0,
"remark": "",
"cache_expiration": 30,
"web_proxy": false,
"webdav_policy": "native_proxy",
"down_proxy_url": "",
"extract_folder": "front",
"enable_sign": false,
"driver": "Local",
"order_by": "name",
"order_direction": "asc",
"addition": "{\"root_folder_path\":\"/\",\"thumbnail\":false,\"thumb_cache_folder\":\"\",\"show_hidden\":true,\"mkdir_perm\":\"777\"}"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||token|
|body|body|object| 否 ||none|
|» mount_path|body|string| 是 | 挂载路径|挂载路径|
|» order|body|integer| 是 | 排序|排序|
|» remark|body|string| 是 | 备注名|备注名|
|» cache_expiration|body|integer| 是 | 缓存过期时间|缓存过期时间|
|» web_proxy|body|boolean| 是 | web代理|web代理|
|» webdav_policy|body|string| 是 | webdav策略|webdav策略|
|» down_proxy_url|body|string| 是 | 下载代理|下载代理|
|» extract_folder|body|string| 是 | 提取目录|提取目录|
|» driver|body|string| 是 | 驱动|驱动|
|» addition|body|string| 是 | 额外信息|额外信息|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"id": 7
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|状态码|
|» message|string|true|none|信息|信息|
|» data|object|true|none|data|data|
|»» id|integer|true|none||none|
## GET 查询指定存储信息
GET /api/admin/storage/get
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 是 ||存储id|
|Authorization|header|string| 是 ||token|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"id": 2,
"mount_path": "/aa",
"order": 1,
"driver": "Aliyundrive",
"cache_expiration": 30,
"status": "work",
"addition": "{\"root_folder_id\":\"\",\"refresh_token\":\"\",\"order_by\":\"size\",\"order_direction\":\"ASC\",\"rapid_upload\":false}",
"remark": "",
"modified": "2022-11-26T21:50:44.142348853+08:00",
"disabled": false,
"order_by": "",
"order_direction": "",
"extract_folder": "front",
"web_proxy": false,
"webdav_policy": "302_redirect",
"down_proxy_url": ""
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|object|true|none||none|
|»» id|integer|true|none|id|none|
|»» mount_path|string|true|none|挂载路径|none|
|»» order|integer|true|none|排序|none|
|»» driver|string|true|none|驱动|none|
|»» cache_expiration|integer|true|none|缓存过期时间|none|
|»» status|string|true|none|状态|none|
|»» addition|string|true|none|额外信息|none|
|»» remark|string|true|none|备注|none|
|»» modified|string|true|none|修改时间|none|
|»» disabled|boolean|true|none|是否被禁用|none|
|»» order_by|string|true|none|排序方式|none|
|»» order_direction|string|true|none|排序方向|none|
|»» extract_folder|string|true|none|提取目录|none|
|»» web_proxy|boolean|true|none|web代理|none|
|»» webdav_policy|string|true|none|webdav策略|none|
|»» down_proxy_url|string|true|none|下载代理|none|
## POST 删除指定存储
POST /api/admin/storage/delete
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|id|query|string| 否 ||存储id|
|Authorization|header|string| 是 ||token|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|状态码|
|» message|string|true|none|信息|信息|
|» data|null|true|none|data|data|
## POST 重新加载所有存储
POST /api/admin/storage/load_all
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||none|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": null
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» code|integer|true|none|状态码|none|
|» message|string|true|none|信息|none|
|» data|null|true|none||none|
# alist/admin/driver
## GET 查询所有驱动配置模板列表
GET /api/admin/driver/list
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Authorization|header|string| 是 ||token|
> 返回示例
> 成功
```json
{
"code": 200,
"message": "success",
"data": {
"115 Cloud": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "webdav_policy",
"type": "select",
"default": "native_proxy",
"options": "use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "cookie",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": "one of QR code token and cookie required"
},
{
"name": "qrcode_token",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": "one of QR code token and cookie required"
},
{
"name": "page_size",
"type": "number",
"default": "56",
"options": "",
"required": false,
"help": "list api per page size of 115 driver"
},
{
"name": "root_folder_id",
"type": "string",
"default": "0",
"options": "",
"required": true,
"help": ""
}
],
"config": {
"name": "115 Cloud",
"local_sort": false,
"only_local": true,
"only_proxy": true,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "0",
"alert": ""
}
},
"123Pan": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "username",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "password",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "root_folder_id",
"type": "string",
"default": "0",
"options": "",
"required": true,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "file_name",
"options": "file_name,size,update_at",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "asc",
"options": "asc,desc",
"required": false,
"help": ""
}
],
"config": {
"name": "123Pan",
"local_sort": false,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "0",
"alert": ""
}
},
"123PanShare": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,modified",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "sharekey",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "sharepassword",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "root_folder_id",
"type": "string",
"default": "0",
"options": "",
"required": true,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "file_name",
"options": "file_name,size,update_at",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "asc",
"options": "asc,desc",
"required": false,
"help": ""
}
],
"config": {
"name": "123PanShare",
"local_sort": true,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": true,
"need_ms": false,
"default_root": "0",
"alert": ""
}
},
"139Yun": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,modified",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "authorization",
"type": "text",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "root_folder_id",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "type",
"type": "select",
"default": "personal",
"options": "personal,family",
"required": false,
"help": ""
},
{
"name": "cloud_id",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
}
],
"config": {
"name": "139Yun",
"local_sort": true,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "",
"alert": ""
}
},
"189Cloud": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,modified",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "username",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "password",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "cookie",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": "Fill in the cookie if need captcha"
},
{
"name": "root_folder_id",
"type": "string",
"default": "-11",
"options": "",
"required": true,
"help": ""
}
],
"config": {
"name": "189Cloud",
"local_sort": true,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "-11",
"alert": "info|You can try to use 189PC driver if this driver does not work."
}
},
"189CloudPC": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "username",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "password",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "validate_code",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "root_folder_id",
"type": "string",
"default": "-11",
"options": "",
"required": true,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "filename",
"options": "filename,filesize,lastOpTime",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "asc",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "type",
"type": "select",
"default": "personal",
"options": "personal,family",
"required": false,
"help": ""
},
{
"name": "family_id",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "upload_method",
"type": "select",
"default": "stream",
"options": "stream,rapid,old",
"required": false,
"help": ""
},
{
"name": "no_use_ocr",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
}
],
"config": {
"name": "189CloudPC",
"local_sort": false,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "-11",
"alert": ""
}
},
"AList V2": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,modified",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "root_folder_path",
"type": "string",
"default": "/",
"options": "",
"required": true,
"help": ""
},
{
"name": "url",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "password",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "access_token",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
}
],
"config": {
"name": "AList V2",
"local_sort": true,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": true,
"need_ms": false,
"default_root": "/",
"alert": ""
}
},
"AList V3": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,modified",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "root_folder_path",
"type": "string",
"default": "/",
"options": "",
"required": true,
"help": ""
},
{
"name": "url",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "meta_password",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "username",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "password",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "token",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
}
],
"config": {
"name": "AList V3",
"local_sort": true,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "/",
"alert": ""
}
},
"Alias": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,modified",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "paths",
"type": "text",
"default": "",
"options": "",
"required": true,
"help": ""
}
],
"config": {
"name": "Alias",
"local_sort": true,
"only_local": false,
"only_proxy": false,
"no_cache": true,
"no_upload": true,
"need_ms": false,
"default_root": "/",
"alert": ""
}
},
"Aliyundrive": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "root_folder_id",
"type": "string",
"default": "root",
"options": "",
"required": true,
"help": ""
},
{
"name": "refresh_token",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,updated_at,created_at",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "ASC,DESC",
"required": false,
"help": ""
},
{
"name": "rapid_upload",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "internal_upload",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
}
],
"config": {
"name": "Aliyundrive",
"local_sort": false,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "root",
"alert": "warning|There may be an infinite loop bug in this driver.\nDeprecated, no longer maintained and will be removed in a future version.\nWe recommend using the official driver AliyundriveOpen."
}
},
"AliyundriveOpen": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "drive_type",
"type": "select",
"default": "default",
"options": "default,resource,backup",
"required": false,
"help": ""
},
{
"name": "root_folder_id",
"type": "string",
"default": "root",
"options": "",
"required": true,
"help": ""
},
{
"name": "refresh_token",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,updated_at,created_at",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "ASC,DESC",
"required": false,
"help": ""
},
{
"name": "oauth_token_url",
"type": "string",
"default": "https://api.xhofe.top/alist/ali_open/token",
"options": "",
"required": false,
"help": ""
},
{
"name": "client_id",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": "Keep it empty if you don't have one"
},
{
"name": "client_secret",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": "Keep it empty if you don't have one"
},
{
"name": "remove_way",
"type": "select",
"default": "",
"options": "trash,delete",
"required": true,
"help": ""
},
{
"name": "rapid_upload",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": "If you enable this option, the file will be uploaded to the server first, so the progress will be incorrect"
},
{
"name": "internal_upload",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": "If you are using Aliyun ECS is located in Beijing, you can turn it on to boost the upload speed"
},
{
"name": "livp_download_format",
"type": "select",
"default": "jpeg",
"options": "jpeg,mov",
"required": false,
"help": ""
}
],
"config": {
"name": "AliyundriveOpen",
"local_sort": false,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "root",
"alert": ""
}
},
"AliyundriveShare": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "refresh_token",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "share_id",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "share_pwd",
"type": "string",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "root_folder_id",
"type": "string",
"default": "root",
"options": "",
"required": true,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,updated_at,created_at",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "ASC,DESC",
"required": false,
"help": ""
}
],
"config": {
"name": "AliyundriveShare",
"local_sort": false,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": true,
"need_ms": false,
"default_root": "root",
"alert": ""
}
},
"BaiduNetdisk": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "refresh_token",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "root_folder_path",
"type": "string",
"default": "/",
"options": "",
"required": true,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "name",
"options": "name,time,size",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "asc",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "download_api",
"type": "select",
"default": "official",
"options": "official,crack",
"required": false,
"help": ""
},
{
"name": "client_id",
"type": "string",
"default": "iYCeC9g08h5vuP9UqvPHKKSVrKFXGa1v",
"options": "",
"required": true,
"help": ""
},
{
"name": "client_secret",
"type": "string",
"default": "jXiFMOPVPCWlO2M5CwWQzffpNPaGTRBG",
"options": "",
"required": true,
"help": ""
},
{
"name": "custom_crack_ua",
"type": "string",
"default": "netdisk",
"options": "",
"required": true,
"help": ""
}
],
"config": {
"name": "BaiduNetdisk",
"local_sort": false,
"only_local": false,
"only_proxy": false,
"no_cache": false,
"no_upload": false,
"need_ms": false,
"default_root": "/",
"alert": ""
}
},
"BaiduPhoto": {
"common": [
{
"name": "mount_path",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": "The path you want to mount to, it is unique and cannot be repeated"
},
{
"name": "order",
"type": "number",
"default": "",
"options": "",
"required": false,
"help": "use to sort"
},
{
"name": "remark",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "cache_expiration",
"type": "number",
"default": "30",
"options": "",
"required": true,
"help": "The cache expiration time for this storage"
},
{
"name": "web_proxy",
"type": "bool",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "webdav_policy",
"type": "select",
"default": "302_redirect",
"options": "302_redirect,use_proxy_url,native_proxy",
"required": true,
"help": ""
},
{
"name": "down_proxy_url",
"type": "text",
"default": "",
"options": "",
"required": false,
"help": ""
},
{
"name": "order_by",
"type": "select",
"default": "",
"options": "name,size,modified",
"required": false,
"help": ""
},
{
"name": "order_direction",
"type": "select",
"default": "",
"options": "asc,desc",
"required": false,
"help": ""
},
{
"name": "extract_folder",
"type": "select",
"default": "",
"options": "front,back",
"required": false,
"help": ""
},
{
"name": "enable_sign",
"type": "bool",
"default": "false",
"options": "",
"required": true,
"help": ""
}
],
"additional": [
{
"name": "refresh_token",
"type": "string",
"default": "",
"options": "",
"required": true,
"help": ""
},
{
"name": "show_type