OpenList
  1. setting
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
    • 获取站点设置
    • ping检测
  • admin
    • meta
      • 列出元信息
      • 获取元信息
      • 新增元信息
      • 更新元信息
      • 删除元信息
    • user
      • 列出所有用户
      • 列出某个用户
      • 新建用户
      • 更新用户信息
      • 取消某个用户的两步验证
      • 删除用户
      • 删除用户缓存
    • storage
      • 创建存储
      • 更新存储
      • 列出存储列表
      • 启用存储
      • 禁用存储
      • 查询指定存储信息
      • 删除指定存储
      • 重新加载所有存储
    • driver
      • 查询所有驱动配置模板列表
      • 列出驱动名列表
      • 列出特定驱动信息
    • setting
      • 列出设置
        GET
      • 获取某项设置
        GET
      • 保存设置
        POST
      • 删除设置
        POST
      • 重置令牌
        POST
      • 设置aria2
        POST
      • 设置qBittorrent
        POST
    • task
      • upload
        • 获取任务信息
        • 获取已完成任务
        • 获取未完成任务
        • 删除任务
        • 取消任务
        • 重试任务
        • 清除已完成任务
        • 清除已成功任务
  1. setting

保存设置

正式环境
http://prod-cn.your-api-server.com
正式环境
http://prod-cn.your-api-server.com
POST
/api/admin/setting/save
alist Copy/admin/setting
最后修改时间:2024-05-17 12:16:17
责任人:未设置

请求参数

Header 参数
Authorization
string 
必需
示例值:
{{alist_token}}
Body 参数application/json
array of:
key
string 
键
必需
value
string 
值
可选
help
string 
帮助信息
可选
type
string 
类型
可选
string, number, bool, select
options
string 
选项
可选
group
integer 
分组
可选
flag
integer 
flag
可选
0 = public, 1 = private, 2 = readonly, 3 = deprecated
示例
[
    {
        "key": "version",
        "value": "v3.25.1",
        "help": "",
        "type": "string",
        "options": "",
        "group": 1,
        "flag": 2
    },
    {
        "key": "site_title",
        "value": "AList",
        "help": "",
        "type": "string",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "announcement",
        "value": "",
        "help": "",
        "type": "text",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "pagination_type",
        "value": "all",
        "help": "",
        "type": "select",
        "options": "all,pagination,load_more,auto_load_more",
        "group": 1,
        "flag": 0
    },
    {
        "key": "default_page_size",
        "value": "30",
        "help": "",
        "type": "number",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "allow_indexed",
        "value": "false",
        "help": "",
        "type": "bool",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "allow_mounted",
        "value": "false",
        "help": "",
        "type": "bool",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "robots_txt",
        "value": "User-agent: *\nAllow: /",
        "help": "",
        "type": "text",
        "options": "",
        "group": 1,
        "flag": 0
    }
]

示例代码

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/admin/setting/save' \
--header 'Authorization: {{alist_token}}' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "key": "version",
        "value": "v3.25.1",
        "help": "",
        "type": "string",
        "options": "",
        "group": 1,
        "flag": 2
    },
    {
        "key": "site_title",
        "value": "AList",
        "help": "",
        "type": "string",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "announcement",
        "value": "",
        "help": "",
        "type": "text",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "pagination_type",
        "value": "all",
        "help": "",
        "type": "select",
        "options": "all,pagination,load_more,auto_load_more",
        "group": 1,
        "flag": 0
    },
    {
        "key": "default_page_size",
        "value": "30",
        "help": "",
        "type": "number",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "allow_indexed",
        "value": "false",
        "help": "",
        "type": "bool",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "allow_mounted",
        "value": "false",
        "help": "",
        "type": "bool",
        "options": "",
        "group": 1,
        "flag": 0
    },
    {
        "key": "robots_txt",
        "value": "User-agent: *\nAllow: /",
        "help": "",
        "type": "text",
        "options": "",
        "group": 1,
        "flag": 0
    }
]'

返回响应

🟢200成功
application/json
Body
code
integer 
状态码
必需
message
string 
信息
必需
data
null 
必需
示例
{
    "code": 200,
    "message": "success",
    "data": null
}
修改于 2024-05-17 12:16:17
上一页
获取某项设置
下一页
删除设置
Built with