OpenList
  1. fs
OpenList
  • auth
    • token获取
      POST
    • token获取hash
      POST
    • 生成2FA密钥
      POST
    • 验证2FA code
      POST
    • 获取当前用户信息
      GET
  • fs
    • 列出文件目录
      POST
    • 获取某个文件/目录信息
      POST
    • 获取目录
      POST
    • 搜索文件或文件夹
      POST
    • 新建文件夹
      POST
    • 重命名文件
      POST
    • 批量重命名
      POST
    • 正则重命名
      POST
    • 移动文件
      POST
    • 聚合移动
      POST
    • 复制文件
      POST
    • 删除文件或文件夹
      POST
    • 删除空文件夹
      POST
    • 添加离线下载
      POST
    • 表单上传文件
      PUT
    • 流式上传文件
      PUT
  • public
    • 获取站点设置
      GET
    • ping检测
      GET
  • admin
    • meta
      • 列出元信息
      • 获取元信息
      • 新增元信息
      • 更新元信息
      • 删除元信息
    • user
      • 列出所有用户
      • 列出某个用户
      • 新建用户
      • 更新用户信息
      • 取消某个用户的两步验证
      • 删除用户
      • 删除用户缓存
    • storage
      • 创建存储
      • 更新存储
      • 列出存储列表
      • 启用存储
      • 禁用存储
      • 查询指定存储信息
      • 删除指定存储
      • 重新加载所有存储
    • driver
      • 查询所有驱动配置模板列表
      • 列出驱动名列表
      • 列出特定驱动信息
    • setting
      • 列出设置
      • 获取某项设置
      • 保存设置
      • 删除设置
      • 重置令牌
      • 设置aria2
      • 设置qBittorrent
    • task
      • upload
        • 获取任务信息
        • 获取已完成任务
        • 获取未完成任务
        • 删除任务
        • 取消任务
        • 重试任务
        • 清除已完成任务
        • 清除已成功任务
  1. fs

添加离线下载

正式环境
http://prod-cn.your-api-server.com
正式环境
http://prod-cn.your-api-server.com
POST
/api/fs/add_offline_download
alist Copy/fs
最后修改时间:2024-05-17 09:24:07
责任人:未设置

请求参数

Header 参数
Authorization
string 
必需
示例值:
{{alist_token}}
Body 参数application/json
urls
array[string]
url
必需
path
string 
目标路径
必需
tool
string 
工具
必需
可选aria2,SimpleHttp和qBittorrent
delete_policy
string 
删除策略
必需
可选delete_on_upload_succeed,delete_on_upload_failed,delete_never,delete_always
示例
{
    "path": "/local",
    "urls": [
        "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png"
    ],
    "tool": "SimpleHttp",
    "delete_policy": "delete_on_upload_succeed"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/api/fs/add_offline_download' \
--header 'Authorization: {{alist_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "path": "/local",
    "urls": [
        "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png"
    ],
    "tool": "SimpleHttp",
    "delete_policy": "delete_on_upload_succeed"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
状态码
必需
message
string 
信息
必需
data
object 
必需
tasks
array [object {6}] 
必需
示例
{
    "code": 200,
    "message": "success",
    "data": {
        "tasks": [
            {
                "id": "jwy7BrfZRzbI2xWg7-y",
                "name": "download https://www.baidu.com/img/20d6cf.png to (/local)",
                "state": 0,
                "status": "",
                "progress": 0,
                "error": ""
            }
        ]
    }
}
修改于 2024-05-17 09:24:07
上一页
删除空文件夹
下一页
表单上传文件
Built with