API 概览
API 概览
Docker
Docker
- 获取 Docker Compose 模板列表GET
/btdocker/compose/template_list - 获取容器执行命令的日志GET
/btdocker/container/get_cmd_log - 获取所有 Docker 容器列表及运行状态GET
/btdocker/container/get_list - 清理所有已停止的无用容器GET
/btdocker/container/prune - 重启 Docker 容器GET
/btdocker/container/restart - 启动已停止的 Docker 容器GET
/btdocker/container/start - 停止运行中的 Docker 容器GET
/btdocker/container/stop - 获取本地 Docker 镜像列表GET
/btdocker/image/image_list - 清理所有无用的 Docker 镜像GET
/btdocker/image/prune - 搜索 Docker Hub 上的镜像GET
/btdocker/image/search - 创建 Docker 网络GET
/btdocker/network/create_network - 获取 Docker 网络列表GET
/btdocker/network/get_host_network - 清理无用的 Docker 网络GET
/btdocker/network/prune - 获取 Docker Compose 项目列表GET
/btdocker/project/get_project_list - 获取 Docker 镜像仓库列表GET
/btdocker/registry/registry_list - 设置 Docker 镜像仓库的备注GET
/btdocker/registry/set_remark - 获取 Docker 的安装状态和配置GET
/btdocker/setup/get_config - 获取 Docker 镜像加速器配置GET
/btdocker/setup/get_registry_mirrors - 安装 Docker 和 Docker Compose(异步任务)GET
/btdocker/setup/install_docker_program - 设置 Docker 监控数据的保留天数GET
/btdocker/setup/set_monitor_save_date - 设置 Docker 官方镜像加速器地址GET
/btdocker/setup/set_registry_mirrors - 创建 Docker 存储卷GET
/btdocker/volume/add - 获取 Docker 存储卷列表GET
/btdocker/volume/get_volume_list - 从 Docker 应用商店安装应用(参数来源于 get_apps 返回值)POST
/mod/docker/com/create_app/stype - 获取 Docker 应用商店的 Git 配置POST
/mod/docker/com/get_apphub_config/stype - 获取 Docker 应用商店的所有可用应用列表(含参数定义)POST
/mod/docker/com/get_apps/stype - 查询应用的依赖是否已安装POST
/mod/docker/com/get_dependence_apps/stype - 初始化 Docker 应用商店环境POST
/mod/docker/com/install_apphub/stype
Java 项目
Java 项目
- 为 Java 项目添加反向代理规则GET
/mod/java/project/add_server_proxy/stype - 为 Java 项目开放外网映射(生成 Nginx 配置文件)GET
/mod/java/project/bind_extranet/stype - 修改 Java 项目的日志存储路径GET
/mod/java/project/change_log_path/stype - 检查 jar 文件的环境变量和配置GET
/mod/java/project/check_env_for_project/stype - 校验 Spring Boot 项目的创建参数GET
/mod/java/project/check_spring_boot_args/stype - 获取 Java 项目的配置文件列表GET
/mod/java/project/config_file_list/stype - 创建 Tomcat 类型的 Java 项目GET
/mod/java/project/create_tomcat_project/stype - 修复 Java 项目的配置GET
/mod/java/project/fix_project/stype - 强制停止 Java 项目进程GET
/mod/java/project/force_stop/stype - 获取 Java 项目的 JMX 监控状态GET
/mod/java/project/get_jmx_status/stype - 获取 Java 项目的更新任务状态GET
/mod/java/project/get_keep_status/stype - 获取 Java 项目的系统负载信息GET
/mod/java/project/get_load_info/stype - 获取 Java 项目的详细信息GET
/mod/java/project/get_project_info/stype - 读取 Spring Boot 项目的日志文件内容GET
/mod/java/project/get_spring_log_data/stype - 获取 Spring Boot 项目的日志文件列表GET
/mod/java/project/get_spring_log_list/stype - 获取 Java 运行环境状态 — JDK 版本、Tomcat 版本GET
/mod/java/project/get_system_info/stype - 获取已安装的 Tomcat 版本及运行状态GET
/mod/java/project/get_tomcat_list/stype - 获取 Java 项目的版本备份列表GET
/mod/java/project/get_version_list/stype - 异步安装指定版本的 JDKGET
/mod/java/project/install_jdk_new/stype - 异步安装指定版本的 TomcatGET
/mod/java/project/install_tomcat_new/stype - 更新任务管理(使用新版/使用旧版/停止新版)GET
/mod/java/project/keep_option/stype - 修改 Java 项目的配置GET
/mod/java/project/modify_project/stype - 修改 Tomcat 的配置(端口、用户、JDK、备注等)GET
/mod/java/project/modify_tomcat/stype - 为 Java 项目创建版本备份GET
/mod/java/project/now_file_backup/stype - 获取运行中 Java 进程的信息,用于导入已有项目GET
/mod/java/project/process_info_for_create/stype - 获取 Java 项目绑定的域名列表GET
/mod/java/project/project_domain_list/stype - 获取所有 Java 项目列表及运行状态GET
/mod/java/project/project_list/stype - 删除 Java 项目(不删除文件)GET
/mod/java/project/remove_project/stype - 删除 Java 项目的反向代理规则GET
/mod/java/project/remove_server_proxy/stype - 删除 Java 项目的版本备份GET
/mod/java/project/remove_version/stype - 重启 Java 项目GET
/mod/java/project/restart_project/stype - 获取 Java 项目的反向代理规则列表GET
/mod/java/project/server_proxy_list/stype - 设置 Java 项目的日志记录开关GET
/mod/java/project/set_project_log_status/stype - 为 Spring Boot 项目设置静态文件路径GET
/mod/java/project/set_static_path/stype - 修改 Java 项目版本备份的备注GET
/mod/java/project/set_version_ps/stype - 启动 Java 项目GET
/mod/java/project/start_project/stype - 启动 Tomcat 项目GET
/mod/java/project/start_tomcat/stype - 停止 Java 项目GET
/mod/java/project/stop_project/stype - 取消 Java 项目的外网映射GET
/mod/java/project/unbind_extranet/stype - 在已有网站下创建 Tomcat 项目(内嵌模式)POST
/mod/java/project/create_site_tomcat_project/stype - 创建 Spring Boot Java 项目,支持绑定域名POST
/mod/java/project/create_spring_boot_project/stype - 批量删除 Java 项目POST
/mod/java/project/multi_remove_project/stype - 批量启动/停止 Java 项目POST
/mod/java/project/multi_set_project/stype
ACME 证书
ACME 证书
计划任务
计划任务
数据查询
数据查询
数据库管理
数据库管理
项目部署
项目部署
文件管理
文件管理
FTP 管理
FTP 管理
Proxy 反向代理
Proxy 反向代理
- Proxy 反向代理:按 action 选择功能POST
/mod/proxy/com/{action}/stype - 为已有反向代理站点添加新的代理规则POST
/mod/proxy/com/add_proxy/stype - 清除反向代理站点缓存POST
/mod/proxy/com/clear_cache/stype - 创建反向代理站点POST
/mod/proxy/com/create/stype - 删除反向代理站点POST
/mod/proxy/com/delete/stype - 获取指定站点的域名列表及 HTTPS 端口POST
/mod/proxy/com/get_domain_list/stype - 获取反向代理站点的全局配置信息POST
/mod/proxy/com/get_global_conf/stype - 获取所有反向代理站点列表,支持分页和搜索POST
/mod/proxy/com/get_list/stype - 获取指定站点的所有反向代理规则列表POST
/mod/proxy/com/get_proxy_list/stype - 获取反向代理站点日志POST
/mod/proxy/com/GetSiteLogs/stype - 设置反向代理站点全局缓存POST
/mod/proxy/com/set_global_cache/stype - 设置反向代理站点全局 Gzip 压缩POST
/mod/proxy/com/set_global_gzip/stype - 设置反向代理站点日志配置POST
/mod/proxy/com/set_global_log/stype - 设置反向代理站点 WebSocket 支持POST
/mod/proxy/com/set_global_websocket/stype - 设置反向代理站点备注POST
/mod/proxy/com/set_remak/stype - 启用或停用反向代理站点POST
/mod/proxy/com/set_site_stop/stype
密码管理
密码管理
消息推送
消息推送
网站管理
网站管理
SSH 安全 - security
SSH 安全
SSL 证书
SSL 证书
系统管理
系统管理
后台任务
后台任务
安全扫描
安全扫描
SSH 终端 - terminal
SSH 终端
文档概览
API 概览
宝塔面板 API 概览
注意:API 接口可能随面板版本变更,不保证稳定性,仅供参考。
基于面板 v11.7.0 源码实测验证,测试环境 Debian 13。
概述
| 项目 | 值 |
|---|---|
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded |
| 认证方式 | 双重 MD5 签名 |
认证
面板设置 → API 接口 → 获取接口密钥 api_sk。
import hashlib, time
request_time = str(int(time.time()))
request_token = hashlib.md5(
(request_time + hashlib.md5(api_sk.encode()).hexdigest()).encode()
).hexdigest()
每次请求必须携带 request_time 和 request_token。
模块
| 模块 | 路由 | 文档 |
|---|---|---|
| 系统管理 | /system |
system/ |
| 网站管理 | /site |
site/ |
| 数据库管理 | /database |
database/ |
| 文件管理 | /files |
files/ |
| SSL 证书 | /ssl |
ssl/ |
| ACME 证书 | /acme |
acme/ |
| Java 项目 | /mod/java/project/ |
java/ |
| 计划任务 | /crontab |
crontab/ |
| FTP 管理 | /ftp |
ftp/ |
| SSH 安全 | /ssh_security |
ssh_security/ |
| 消息推送 | /push |
push/ |
| 后台任务 | /task |
task/ |
| SSH 终端 | /xterm |
xterm/ |
| 数据查询 | /data |
data/ |
| 安全扫描 | /warning |
warning/ |
| 密码管理 | /password |
password/ |
| 项目部署 | /deployment |
deployment/ |