宝塔文件api

已于 2024-08-09 07:47:41 修改
阅读量956 收藏 30
点赞数 28
分类专栏： 宝塔 文章标签： php
于 2024-08-08 10:40:06 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45740393/article/details/141020289
版权

最近想使用宝塔api来完成一些自动化的操作，发现官方文档对于较新接口没有文档，我就模仿官方的风格自己写了一份。
由于目前我主要用到文件接口，后续用到其他接口的时候，会逐步把这个文档补全。
官方文档链接：https://www.bt.cn/data/api-doc.pdf

注意：所有数据都经过了脱敏处理，而且为了最好的呈现接口请求和返回的数据，可能会存在部分数据对不上的情况。
宝塔版本：9.1.0

获取目录内容

URI地址：/files?action=GetDirNew​

说明：查询指定目录下的文件和文件夹

请求参数：

参数名称参数示例值参数类型说明是否必传
p1number当前分页是
showRow500number每一页显示多少是
path/www/wwwroot/test.com/aaastring查询的文件夹目录是
searcha.tar.gzstring搜索文件或者目录否
alltruebool是否搜索子目录否

返回示例：

{
	// 未知
    "store": [],

	// 未知
    "file_recycle": true,

	// 前端分页器显示使用
    "page": "<div><span class='Pcurrent'>1</span><span class='Pnumber'>1/1</span><span class='Pline'>从1-2条</span><span class='Pcount'>共2条</span></div>",

	// 当前路径
    "path": "/www/wwwroot/test.com/aaa",

	// 当前路径下的文件夹列表
    "dir": [
		{
            "nm": "01",        // 文件名
            "sz": 4096,        // 文件大小
            "mt": 1721820262,  // 文件创建时间
            "acc": "755",      // 文件权限
            "user": "www",     // 文件所属用户
            "lnk": "",
            "durl": "",
            "cmp": 0,
            "fav": "0",
            "rmk": "",         // 文件备注
            "top": 0,          // 文件是否置顶
            "sn": "01"
        },
	],

	// 当前路径下的文件列表
    "files": [
        {
            "nm": "a.tar.gz",
            "sz": 489171,
            "mt": 1723080431,
            "acc": "755",
            "user": "www",
            "lnk": "",
            "durl": "",
            "cmp": 0,
            "fav": "0",
            "rmk": "",
            "top": 0,
            "sn": "fangyu_0_0_3.tar.gz"
        }
    ],

	// 文件夹访问历史记录
    "dir_history": [
        {
            "val": "/www/wwwroot",  // 访问内容
            "time": 1714820346      // 访问时间
        }
    ],

	// 文件搜索历史记录
    "search_history": [
		{
            "val": "a.tar.gz",  // 搜索内容
            "time": 1723082202  // 搜索时间
        }
	],

	// 未知
    "tamper_data": {   
        "status": false,
        "msg": "插件不存在!"
    },

	// 未知
    "bt_sync": []
}

‍

检测文件是否存在

URI地址：/files?action=upload_files_exists​

说明：用于检测一个或者多个文件是否已经存在，一般在上传文件之前检测

请求参数：

参数名称参数示例值参数类型说明是否必传
files/www/wwwroot/test.com/1.jpg\n/www/wwwroot/test.com/2.jpgstring文件的绝对路径，多个文件用换行符分割是

返回示例：

[
    {
        "filename": "/www/wwwroot/test.com/1.jpg",  // 文件名
        "exists": false,                            // 文件是否存在
        "size": 0,                                  // 文件大小
        "mtime": 0,                                 // 文件上传时间
        "isfile": false                             // 是否为文件
    },
    {
        "filename": "/www/wwwroot/test.com/2.jpg",
        "exists": true,
        "size": 489380,
        "mtime": 1723079747,
        "isfile": true
    }
]

‍

上传文件

URI地址：/files?action=upload​

说明：用于上传单个文件

请求参数：

参数名称参数示例值参数类型说明是否必传
f_path/www/wwwroot/test.com/string上传此目录是
f_name3.jpgstring上传文件名是
f_size102340number文件大小(字节单位)是
f_start0number默认为0，意义不明是
blob(二进制)stream字节流，文件内容是
request_time1723082316467number上传时间是
request_tokend199a518eda49a2617a4c35c37ee0330string请求token，意义不明是

返回示例：

{
	"status": true,    // 用于说明上传是否成功
	"msg": "上传成功!"  // 前端显示消息
}

补充说明：

request_token 字段的计算方式我在源码里面找到了，window.vite_public_proxy_key 为空字符串

function getToken() {
    const e = Date.now(), t = window.vite_public_proxy_key;
    return {
        requestTime: e,
        requestToken: md5(String(e).concat(md5(t)))
    }
}

下面是等价的 python 代码 (3.10版本)

import hashlib
import time

def get_token():
    request_time = int(time.time() * 1000)
    proxy_key = ''

    token_string = str(request_time) + hashlib.md5(proxy_key.encode()).hexdigest()
    request_token = hashlib.md5(token_string.encode()).hexdigest()

    return {
        "requestTime": request_time,
        "requestToken": request_token
    }

宝塔api

‍

获取目录内容

URI地址：/files?action=GetDirNew​

说明：查询指定目录下的文件和文件夹

请求参数：

参数名称参数示例值参数类型说明是否必传
p1number当前分页是
showRow500number每一页显示多少是
path/www/wwwroot/test.com/aaastring查询的文件夹目录是
searcha.tar.gzstring搜索文件或者目录否
alltruebool是否搜索子目录否

返回示例：

{
	// 未知
    "store": [],

	// 未知
    "file_recycle": true,

	// 前端分页器显示使用
    "page": "<div><span class='Pcurrent'>1</span><span class='Pnumber'>1/1</span><span class='Pline'>从1-2条</span><span class='Pcount'>共2条</span></div>",

	// 当前路径
    "path": "/www/wwwroot/test.com/aaa",

	// 当前路径下的文件夹列表
    "dir": [
		{
            "nm": "01",        // 文件名
            "sz": 4096,        // 文件大小
            "mt": 1721820262,  // 文件创建时间
            "acc": "755",      // 文件权限
            "user": "www",     // 文件所属用户
            "lnk": "",
            "durl": "",
            "cmp": 0,
            "fav": "0",
            "rmk": "",         // 文件备注
            "top": 0,          // 文件是否置顶
            "sn": "01"
        },
	],

	// 当前路径下的文件列表
    "files": [
        {
            "nm": "a.tar.gz",
            "sz": 489171,
            "mt": 1723080431,
            "acc": "755",
            "user": "www",
            "lnk": "",
            "durl": "",
            "cmp": 0,
            "fav": "0",
            "rmk": "",
            "top": 0,
            "sn": "fangyu_0_0_3.tar.gz"
        }
    ],

	// 文件夹访问历史记录
    "dir_history": [
        {
            "val": "/www/wwwroot",  // 访问内容
            "time": 1714820346      // 访问时间
        }
    ],

	// 文件搜索历史记录
    "search_history": [
		{
            "val": "a.tar.gz",  // 搜索内容
            "time": 1723082202  // 搜索时间
        }
	],

	// 未知
    "tamper_data": {   
        "status": false,
        "msg": "插件不存在!"
    },

	// 未知
    "bt_sync": []
}

‍

检测文件是否存在

URI地址：/files?action=upload_files_exists​

说明：用于检测一个或者多个文件是否已经存在，一般在上传文件之前检测

请求参数：

参数名称参数示例值参数类型说明是否必传
files/www/wwwroot/test.com/1.jpg\n/www/wwwroot/test.com/2.jpgstring文件的绝对路径，多个文件用换行符分割是

返回示例：

[
    {
        "filename": "/www/wwwroot/test.com/1.jpg",  // 文件名
        "exists": false,                            // 文件是否存在
        "size": 0,                                  // 文件大小
        "mtime": 0,                                 // 文件上传时间
        "isfile": false                             // 是否为文件
    },
    {
        "filename": "/www/wwwroot/test.com/2.jpg",
        "exists": true,
        "size": 489380,
        "mtime": 1723079747,
        "isfile": true
    }
]

‍

上传文件

URI地址：/files?action=upload​

说明：用于上传单个文件

请求参数：

参数名称参数示例值参数类型说明是否必传
f_path/www/wwwroot/test.com/string上传此目录是
f_name3.jpgstring上传文件名是
f_size102340number文件大小(字节单位)是
f_start0number默认为0，意义不明是
blob(二进制)stream字节流，文件内容是
request_time1723082316467number上传时间是
request_tokend199a518eda49a2617a4c35c37ee0330string请求token，意义不明是

返回示例：

{
	"status": true,    // 用于说明上传是否成功
	"msg": "上传成功!"  // 前端显示消息
}

补充说明：

request_token 字段的计算方式我在源码里面找到了，window.vite_public_proxy_key 为空字符串

function getToken() {
    const e = Date.now(), t = window.vite_public_proxy_key;
    return {
        requestTime: e,
        requestToken: md5(String(e).concat(md5(t)))
    }
}

下面是等价的 python 代码 (3.10版本)

import hashlib
import time

def get_token():
    request_time = int(time.time() * 1000)
    proxy_key = ''

    token_string = str(request_time) + hashlib.md5(proxy_key.encode()).hexdigest()
    request_token = hashlib.md5(token_string.encode()).hexdigest()

    return {
        "requestTime": request_time,
        "requestToken": request_token
    }

批量操作文件

URI地址：/files?action=SetBatchData​

说明：当操作文件大于一个的时候，调用此接口

请求参数：

参数名称参数示例值参数类型说明是否必传
data[“index.html”,“favicon.ico”]string_array操作的文件名数组是
type4number文件操作类型是
path/www/wwwroot/veys.qadub.monster/string操作的路径是
userwwwstring修改权限时，新的所属用户否
access755string修改权限时，新的访问控制规则否
alltruebool修改权限时，是否递归修改文件夹否

类型常量说明：

1  批量复制文件
2  批量剪切文件
3  批量修改文件权限
4  批量删除文件

返回示例：

{
	"status": true,                         // 用于说明操作是否成功
	"msg": "已批量将2个文件或目录移动到回收站"  // 前端显示消息
}

‍

获取文件内容

URI地址：/files?action=GetFileBody​

说明：获取指定文件的内容

请求参数：

参数名称参数示例值参数类型说明是否必传
path/www/wwwroot/test.com/index.htmlstring要获取文件的绝对路径是

返回示例：

{

    "status": true,              // 说明接口请求是否成功
    "only_read": false,          // 是否为只读文件
    "size": 205,                 // 文件大小, 字节单位
    "encoding": "utf-8",         // 文件编码方式

	// 文件的内容
    "data": "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <meta charset=\"UTF-8\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n    <title>Document</title>\n</head>\n<body>\n    \n</body>\n</html>",

    "historys": ["1723157356"],  // 文件修改历史记录
    "auto_save": null,           // 自动保存, 不知道用途, 可能是新版本的功能
    "st_mtime": "1723157356"     // 修改时间
}

‍

保存文件内容

URI地址：/files?action=GetFileBody​

说明：获取指定文件的内容

请求参数：

参数名称参数示例值参数类型说明是否必传
path/www/wwwroot/test.com/index.htmlstring要保存文件的绝对路径是
datateststring新的文件内容是
encodingutf-8string新的文件编码是
st_mtime1723158504number修改时间戳是
force0number源码常数为0，意义未知是

返回示例：

{
    "status": true,           // 说明接口请求是否成功
    "msg": "文件已保存!",      // 前端显示消息
    "historys": [             // 文件修改历史记录
        "1723158907",
        "1723158504",
        "1723157356"
    ],
    "st_mtime": "1723158907"  // 文件修改时间
}

‍

添加文件修改记录

URI地址：/files?action=file_history​

说明：修改文件时调用此接口，添加文件修改记录

请求参数：

参数名称参数示例值参数类型说明是否必传
nameundefinedstring意义未知是
path/www/wwwroot/test.com/index.htmlstring修改文件的绝对路径是

返回示例：

{
	"status": true,   // 用于说明操作是否成功
	"msg": "添加成功"  // 前端显示消息
}

‍

移动和重命名文件

URI地址：/files?action=MvFile​

说明：重命名文件时调用

请求参数：

参数名称参数示例值参数类型说明是否必传
sfile/www/wwwroot/test.com/index.htmlstring老文件路径是
dfile/www/wwwroot/test.com/index.html.bakstring新文件路径是
renametruebool是否重命名否

补充说明：

rename 在剪切到不同目录时，是不用传递的。只有对文件重命名时需要传递。

如果剪切文件粘贴到原来的目录，也是需要传递的，猜测宝塔底层可能把这种行为处理为重命名了。

返回示例：

{
	"status": true,     // 用于说明操作是否成功
	"msg": "重命名成功!"  // 前端显示消息
}

‍

复制文件

URI地址：/files?action=CopyFile​

说明：复制文件时调用

请求参数：

参数名称参数示例值参数类型说明是否必传
sfile/www/wwwroot/test.com/01/index.htmlstring老文件路径是
dfile/www/wwwroot/test.com/02/index.htmlstring新文件路径是

返回示例：

{
	"status": true,       // 用于说明操作是否成功
	"msg": "文件复制成功!"  // 前端显示消息
}

‍

删除文件

URI地址：/files?action=DeleteFile​

说明：删除文件时调用

请求参数：

参数名称参数示例值参数类型说明是否必传
path/www/wwwroot/test.com/index.htmlstring删除文件路径是

返回示例：

{
	"status": true,              // 用于说明操作是否成功
	"msg": "已将文件移动到回收站!"  // 前端显示消息
}

‍

检查目录是否存在

URI地址：/files?action=test_path​

说明：删除文件时调用

请求参数：

参数名称参数示例值参数类型说明是否必传
path/www/wwwroot/test.com/string要检查的目录是

返回示例：

// 存在的返回值
{
	"path": "/www/wwwroot/test.com/",  // 目标路径
	"is_dir": true,                    // 是否为目录
	"exists": true                     // 是否存在
}

// 不存在的返回值
{
	"path": "", 
	"is_dir": null, 
	"exists": false
}
qq_45740393
关注
  • 28
    点赞
  • 踩
  • 30
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
PHP操作宝塔面板Api，宝塔服务器搭建，API接口使用教程
企业级技术与网站app运营
05-23 2551
收集了很多很多宝塔常用到的一些Api接口，宝塔面板的接口如何抓取，codeit.org.cn。直接下载附件，将Bt.php与config.php放在同级目录中，然后修改成自己的宝塔接口和Api密钥，访问即可获得宝塔。文件中收集的接口并不是宝塔面板全部接口，如需更多参考接口抓取自行添加，接口地址及数据请以官方为准。上面的XHR都是我们抓取到的APi接口，下面我演示一下创建网站的接口。// 修改成自己的宝塔接口和Api密钥。2、找到自己想要的功能。
PHP:宝塔面板API实现服务器信息前端展示
m0_66607265的博客
04-16 1384
PHP:宝塔面板API实现服务器信息前端展示 首先可以看看上面的成品，由于个人需要只展示CPU和内存的使用率，可以展示的服务器信息还包括以下官方API接口文档中提及的 根据该文档，我写出了一个在PHP中调用API实现服务器信息前端展示的Demo 也可以用其它方式调用，比如官方推荐的Python、我个人较倾向于Java 调用后将输出JSON数据，这里有一个例子
宝塔LInux面板API
qq_64519337的博客
04-07 645
通过宝塔API，可以完全控制宝塔Linux面板的所有功能，包括第三方插件应用功能，事实上，在用户登录面板 后使用的所有功能也是通过相同的接口对接的，这意味着，如果你熟悉使用浏览器调试器，就可以轻松对照宝塔Linux 面板的操作参数完成一个第三方的前端对接。
最新宝塔反代openai官方API开发接口详细搭建教程，解决502 Bad Gateway问题
学习笔记，人工智能，教程，技术分享！
11-14 1937
这里使用的方法为宝塔自带的反向代理功能，就正常的方法。使用SSL，得解决Nginx三次握手的问题。
宝塔API批量建站工具-使用说明
qq_40802724的博客
01-02 1734
宝塔API多服务器管理，一键批量建站的工具。
基于宝塔面板和Node.JS开发简单的API接口
m0_46987340的博客
07-04 1971
介绍如何使用Node.js在服务器上搭建简单的API接口。首先，需要开放服务器的端口并安装宝塔面板和Node.js，解决跨域问题。通过命令行安装Node.js和第三方模块，如Express、Nodemon等。接着，可以使用Express框架创建服务器应用程序，处理GET和POST请求。代码示例展示了如何接收客户端发送的数据并将其写入到一个JSON文件中，以及如何使用jQuery和Ajax发送GET请求并展示响应结果。总的来说，这篇博客提供了详细的API接口搭建教程，适合对API接口搭建有兴趣的读者学习和实践
宝塔api使用说明(php版本)
元曦的博客
04-16 915
demo.php <?php /** * 宝塔API接口示例Demo * 仅供参考，请根据实际项目需求开发，并做好安全处理 * date 2018/12/12 * author 阿良 */ class bt_api { private $BT_KEY = "thVLXFtUCCNzBShBweKTPBmw8296q8R8"; //接口密钥 private $BT_PANEL = "http://127.0.0.1:8888"; //面板地址 //如果希望多台面板
宝塔百度推送API插件
08-03
宝塔百度推送API插件是一款专为宝塔面板用户设计的工具，用于集成百度的智能云推送服务。宝塔面板是一款流行的Linux服务器管理软件，它提供了图形化的操作界面，使得服务器管理和运维工作变得简单易行。这款插件的...
宝塔批量建站工具,很优秀的宝塔管理工具,基于宝塔api
最新发布
04-28
基于宝塔面板的API接口，该工具能够与宝塔服务器管理平台无缝集成，实现自动化和批量化的网站创建、配置和维护功能。 宝塔面板本身是一款强大的Linux服务器管理工具，提供了简洁易用的图形界面，让不懂Linux命令行...
Api-auxpi.zip
09-18
- 源代码文件：实现API辅助功能的Python、Java或其他语言的代码。 - 测试文件：用于验证API辅助工具功能的测试用例。 - 文档：详细解释API的使用方法和各个功能的文档。 通过这样的辅助工具，开发者可以方便地进行...
宝塔面板手册-06181102.pdf
10-23
宝塔面板手册，来源于网上的大神分享，希望对大家有所帮助
宝塔批量建站.zip
07-27
宝塔批量建站，好用！批量操作，一小时建几百个站点！
宝塔Linux面板手册
04-10
快速搭建基于Linux+Apache+Mysql+PHP的web运行环境，图像化添加各个组件。
BT-Server-Monitor:基于宝塔面板 API 的服务器状态监控面板
07-24
BT-Server-Monitor 一个基于宝塔面板 API 的服务器状态监控面板 演示： 特点 使用 PHP 制作，部署简单 使用宝塔 API，无需部署其他环境 漂亮的自适应 Material Design 样式（来自 ） Main 和 Another 的区别 可能已经有人看到本仓库还有一个 Another 分支，这里简单讲一下 Another 和 Main 的区别： Main 使用一台服务器聚合所有信息，Another 则使用客户端分别向服务器请求信息。 所以，如果你的各个服务器之间通讯缓慢，推荐你使用 Another 分支，否则直接使用 Main 分支即可。 安装 登录你服务器的宝塔面板，点击 设置； 打开 API 接口 开关，记录对应密钥，然后在 IP 白名单 中填写主服务器的 IP，保存； 下载本仓库源码，打开 /src/get.php，将你希望显示的服务器名称、服务器的面板地址
该文件是宝塔redis工具类
07-11
工具类会封装这些命令，使得开发者可以通过简单的API调用来执行复杂的Redis操作。 3. **事务处理**：Redis支持事务（Transaction），允许一次性执行多条命令。工具类会提供开始、提交和回滚事务的功能，保证数据...
Bty主机分销系统v1.0开源版源码基于宝塔开放API底层控制器，进行主机控制.zip
01-10
使用宝塔API接入服务器可实现网站操作，网站开通、域名绑定、 ssl证书、防盗链、一键部署、网站防篡改、网站监控报表、防火墙等功能 配合宝塔强大的生态系统，安装更多插件后可使用到许多有趣的功能 内置易支付，...
实用教程用Laravel是怎么操作宝塔面板API
主题模板站的博客
01-18 456
给大家介绍laravel+宝塔面板的相关知识，主要给大家分享Laravel是怎么操作宝塔面板API，下面就带大家一起来看看，希望对需要的朋友有所帮助！其他的接口请查看官方文档：https://www.bt.cn/api-doc.pdf。Laravel 操作宝塔面板 API。不一样的地方根据自身业务修改！
本地宝塔showdoc api文档服务搭建
weixin_45487630的博客
02-09 693
本地环境宝塔搭建showdoc api文档服务器
宝塔反代openai官方API接口详细教程，502 Bad Gateway问题解决
学习笔记，人工智能，教程，技术分享！
09-30 4657
宝塔反代openai官方API接口详细教程，实现国内使用ChatGPT+502 Bad Gateway问题解决， 此方法最简单快捷，没有复杂步骤，不容易出错，即最简单，零代码、零部署的方法。
设置无标题 android
05-02
在Android应用中，设置无标题是一种简洁和美观的设计方式，可以为用户提供更流畅的使用体验。以下是一些实现设置无标题的方法： 1. 在Android的Manifest文件中，找到对应Activity的标签，并添加”android:theme="@android:style/Theme.NoTitleBar"“属性。这样可以通过Android自带的主题去掉标题栏。 2. 使用自定义的主题，可以在样式表中添加以下代码： <style name="AppTheme" parent="Theme.AppCompat.NoActionBar"> <!-- ...其他样式... --> </style> 这种方式可以通过设置主题去除ActionBar和标题栏，同时保留其他布局元素。 3. 去掉代码中的setTitle()方法，这是一种最简单的方法，通过不设置Activity的标题来实现无标题。 以上就是三种常见的实现Android无标题的方式，开发者可以根据实际需求进行选择。值得注意的是，去除标题栏可能会影响用户的导航体验，因此在设计上需要考虑周全。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值