宝塔 Linux 面板 API 文档

前言

通过宝塔 API，可以完全控制宝塔 Linux 面板的所有功能，包括第三方插件应用功能，事实上，在用户登录面板后使用的所有功能也是通过相同的接口对接的，这意味着，如果你熟悉使用浏览器调试器，就可以轻松对照宝塔 Linux面板的操作参数完成一个第三方的前端对接。

 文煞站长资源网提供pdf文档、doc文档、PHP版demo下载：https://www.wszzw.cn/post/162.html

签名算法

api_sk = 接口密钥 (在面板设置页面 - API 接口中获取)

request_time = 当前请求时间的 uinx 时间戳 ( php: time() / python: time.time() ) request_token = md5(string(request_time) + md5(api_sk))

PHP 示例： $request_token = md5($request_time . ‘’ . md5($api_sk))

签名：

注意事项：

1、请统一使用 POST 方式请求 API 接口

2、为了确保请求效率，请保存 cookie，并在每次请求时附上 cookie 3、为了面板安全考虑，请务必添加 IP 白名单

4、所有响应内容统一为 Json 数据格式

DEMO 下载

PHP-Demo: https://www.bt.cn/api_demo_php.zip

系统状态相关接口

获取系统基础统计

URI 地址：/system?action=GetSystemTotal传入参数：无

响应内容：

响应内容示例：

{

"cpuRealUsed": 0.85,

"memTotal": 1741,

"system": "CentOS Linux 7.5.1804 (Core)", "memRealUsed": 691,

"cpuNum": 6,

"memFree": 189,

"version": "6.8.1",

"time": "0\u592923\u5c0f\u65f657\u5206\u949f", "memCached": 722,

"memBuffers": 139,

"isuser": 0

}

获取磁盘分区信息

URI 地址：/system?action=GetDiskInfo传入参数：无

响应内容：

响应内容示例：

[

{"path": "/",

"inodes": ["8675328", "148216", "8527112", "2%"],

"size": ["8.3G", "4.0G", "4.3G", "49%"]

},

{

"path": "/www",

"inodes": ["655360", "295093", "360267", "46%"],

"size": ["9.8G", "3.7G", "5.6G", "40%"]

}

]

获取实时状态信息(CPU、内存、网络、负载)

URI 地址：/system?action=GetNetWork传入参数：无

响应内容：

响应内容示例：

{

"load": {"max": 12, "safe": 9.0, "one": 0.01, "five": 0.02, "limit": 12, "fifteen": 0.05},

"down": 8.77,

"downTotal": 453078627,

"mem": {"memFree": 189, "memTotal": 1741, "memCached": 722, "memBuffers": 140, "memRealUsed": 690},

"up": 4.33,

"upTotal": 78070942,

"upPackets": 177930,

"downPackets": 1548192,

"cpu": [0.23, 6]

}

检查是否有安装任务

URI 地址：/ajax?action=GetTaskCount传入参数：无

响应内容： 响应内容： 0

检查面板更新

URI 地址：/ajax?action=UpdatePanel

响应内容：

响应内容示例：

{

"status": true, "version": "6.8.2",

"updateMsg": "升级说明"

}

网站管理

获取网站列表

URI 地址：/data?action=getData&table=sites

响应内容：

响应内容示例：

{

"data": [

{

"status": "1",

"ps": "bbb.com", "domain": 1, "name": "bbb.com",

"addtime": "2018-12-14 16:14:03",

"path": "/www/wwwroot/bbb.com", "backup_count": 0,

"edate": "0000-00-00",

"id": 64

}

],

"where": "type_id=0",

"page": "<div><span class='Pcurrent'>1</span><span class='Pcount'>\u51711\u6761\u6570\u636e</span></div>"

}

获取网站分类

URI 地址：/site?action=get_site_types传入参数：空

响应内容示例：

[

{"id": 0, "name": "\u9ed8\u8ba4\u5206\u7c7b"}

]

获取已安装的 PHP 版本列表

URI 地址：/site?action=GetPHPVersion传入参数：空

响应内容示例：

[

{"version": "00", "name": "\u7eaf\u9759\u6001"},

{"version": "56", "name": "PHP-56"},

{"version": "72", "name": "PHP-72"}

]

创建网站

URI 地址：/site?action=AddSite

响应内容：

响应内容示例：

{

"ftpStatus": true,

"databaseUser": "w2_hao_com", "databaseStatus": true,

"ftpUser": "w2_hao_com", "databasePass": "PdbNjJy5hBA346AR", "siteStatus": true,

"ftpPass": "sRxmY6xCn6zEsFtG"

}

删除网站

URI 地址：/site?action=DeleteSite

响应内容：

响应内容示例：

{

"status": true,

"msg": "\u7ad9\u70b9\u5220\u9664\u6210\u529f!"

}

停用网站

URI 地址：/site?action=SiteStop

响应内容示例：

{

"status": true,

"msg": "\u7ad9\u70b9\u5220\u9664\u6210\u529f!"

}

启用网站

URI 地址：/site?action=SiteStart

响应内容示例：

{

"status": true,

"msg": "\u7ad9\u70b9\u5df2\u542f\u7528"

}

网站到期时间

URI 地址：/site?action=SetEdate

响应内容示例：

{

"status": true,

"msg": "\u7ad9\u70b9\u5df2\u542f\u7528"

}

修改网站备注

URI 地址：/data?action=setPs&table=sites

响应内容示例：

{

"status": true,

"msg": "\u4fee\u6539\u6210\u529f"

}

获取网站备份列表

URI 地址：/data?action=getData&table=backup

响应内容：

响应内容示例：

{

"data": [],

"where": "pid=65 and type='0'",

"page": "<div><span class='Pcurrent'>1</span><span class='Pcount'>\u51710\u6761\u6570\u636e</span></div>"

}

创建网站备份

URI 地址：/site?action=ToBackup

响应内容示例：

{

"status": true,

"msg": "\u5907\u4efd\u6210\u529f!"

}

删删网站备份

URI 地址：/site?action=DelBackup

响应内容示例：

{

"status": true,

"msg": "\u5220\u9664\u6210\u529f"

}

获取网站的域名列表

URI 地址：/data?action=getData&table=domain

响应内容示例：

[

{

"port": 80,

"addtime": "2018-12-15 16:57:30",

"pid": 65,

"id": 73,

"name": "w1.hao.com"

}

]

添加域名

URI 地址：/site?action=AddDomain

响应内容示例：

{

"status": true,

"msg": "\u57df\u540d\u6dfb\u52a0\u6210\u529f!"

}

删除域名

URI 地址：/site?action=DelDomain

响应内容示例：

{

"status": true,

"msg": "\u5220\u9664\u6210\u529f"

}

获取可选的预定义伪静态列表

URI 地址：/site?action=GetRewriteList

响应内容：

响应内容示例：

{

"rewrite": ["0.\u5f53\u524d", "EmpireCMS", "dabr", "dbshop", "dedecms", "default", "discuz", "discuzx",

"discuzx2", "discuzx3", "drupal", "ecshop", "emlog", "laravel5", "maccms", "mvc", "niushop", "phpcms", "phpwind",

"sablog", "seacms", "shopex", "thinkphp", "typecho", "typecho2", "weengine", "wordpress", "wp2", "zblog"]

}

获取指定预定义伪静态规则内容(获取文件内容)

URI 地址：/files?action=GetFileBody

保存伪静态规则内容(保存文件内容)

URI 地址：/files?action=SaveFileBody

取回指定网站的根目录

URI 地址：/data?action=getKey&table=sites&key=path

取回防跨站配置/运行目录/日志开关状态/可设置的运行目录列表/密码访问状态

URI 地址：/site?action=GetDirUserINI

响应内容示例：

{

"pass": false, #是否设置密码访问 "logs": true, #是否写访问日志 "userini": true, #是否设置防跨站 "runPath": {

"dirs": ["/"], #可用于设置运行目录的目录列表 "runPath": "/" #当前运行目录

}

}

设置防跨站状态(自动取反)

URI 地址：/site?action=SetDirUserINI

设置是否写访问日志

URI 地址：/site?action=logsOpen

修改网站根目录

URI 地址：/site?action=SetPath

设置是否写访问日志

URI 地址：/site?action=SetSiteRunPath

设置密码访问

URI 地址：/site?action=SetHasPwd

关闭密码访问

URI 地址：/site?action=CloseHasPwd

获取流量限制相关配置（仅支持 nginx）

URI 地址：/site?action=GetLimitNet

开启或保存流量限制配置（仅支持 nginx）

URI 地址：/site?action=SetLimitNet

关闭流量限制（仅支持 nginx）

URI 地址：/site?action=CloseLimitNet

取默认文档信息

URI 地址：/site?action=GetIndex

设置默认文档

URI 地址：/site?action=SetIndex

取网站配置文件内容(获取文件内容)

URI 地址：/files?action=GetFileBody

保存网站配置文件(保存文件内容)

URI 地址：/files?action=SaveFileBody