# API 概览

API 概览

Version: 11.7.0-docs

## Servers

- `https://your-panel.example.com:8888`

## [Docker](https://docs.bt.cn/api/tags/Docker/)

Docker

- [获取 Docker Compose 模板列表](https://docs.bt.cn/api/docker/template-list/) — `GET /btdocker/compose/template_list`
- [获取容器执行命令的日志](https://docs.bt.cn/api/docker/get-cmd-log/) — `GET /btdocker/container/get_cmd_log`
- [获取所有 Docker 容器列表及运行状态](https://docs.bt.cn/api/docker/get-list/) — `GET /btdocker/container/get_list`
- [清理所有已停止的无用容器](https://docs.bt.cn/api/docker/prune-container/) — `GET /btdocker/container/prune`
- [重启 Docker 容器](https://docs.bt.cn/api/docker/restart/) — `GET /btdocker/container/restart`
- [启动已停止的 Docker 容器](https://docs.bt.cn/api/docker/start/) — `GET /btdocker/container/start`
- [停止运行中的 Docker 容器](https://docs.bt.cn/api/docker/stop/) — `GET /btdocker/container/stop`
- [获取本地 Docker 镜像列表](https://docs.bt.cn/api/docker/image-list/) — `GET /btdocker/image/image_list`
- [清理所有无用的 Docker 镜像](https://docs.bt.cn/api/docker/prune-image/) — `GET /btdocker/image/prune`
- [搜索 Docker Hub 上的镜像](https://docs.bt.cn/api/docker/search-image/) — `GET /btdocker/image/search`
- [创建 Docker 网络](https://docs.bt.cn/api/docker/create-network/) — `GET /btdocker/network/create_network`
- [获取 Docker 网络列表](https://docs.bt.cn/api/docker/get-host-network/) — `GET /btdocker/network/get_host_network`
- [清理无用的 Docker 网络](https://docs.bt.cn/api/docker/prune-network/) — `GET /btdocker/network/prune`
- [获取 Docker Compose 项目列表](https://docs.bt.cn/api/docker/get-project-list/) — `GET /btdocker/project/get_project_list`
- [获取 Docker 镜像仓库列表](https://docs.bt.cn/api/docker/registry-list/) — `GET /btdocker/registry/registry_list`
- [设置 Docker 镜像仓库的备注](https://docs.bt.cn/api/docker/set-remark/) — `GET /btdocker/registry/set_remark`
- [获取 Docker 的安装状态和配置](https://docs.bt.cn/api/docker/get-config/) — `GET /btdocker/setup/get_config`
- [获取 Docker 镜像加速器配置](https://docs.bt.cn/api/docker/get-registry-mirrors/) — `GET /btdocker/setup/get_registry_mirrors`
- [安装 Docker 和 Docker Compose（异步任务）](https://docs.bt.cn/api/docker/install-docker-program/) — `GET /btdocker/setup/install_docker_program`
- [设置 Docker 监控数据的保留天数](https://docs.bt.cn/api/docker/set-monitor-save-date/) — `GET /btdocker/setup/set_monitor_save_date`
- [设置 Docker 官方镜像加速器地址](https://docs.bt.cn/api/docker/set-registry-mirrors/) — `GET /btdocker/setup/set_registry_mirrors`
- [创建 Docker 存储卷](https://docs.bt.cn/api/docker/add-volume/) — `GET /btdocker/volume/add`
- [获取 Docker 存储卷列表](https://docs.bt.cn/api/docker/get-volume-list/) — `GET /btdocker/volume/get_volume_list`
- [从 Docker 应用商店安装应用（参数来源于 get_apps 返回值）](https://docs.bt.cn/api/docker/create-app/) — `POST /mod/docker/com/create_app/stype`
- [获取 Docker 应用商店的 Git 配置](https://docs.bt.cn/api/docker/get-apphub-config/) — `POST /mod/docker/com/get_apphub_config/stype`
- [获取 Docker 应用商店的所有可用应用列表（含参数定义）](https://docs.bt.cn/api/docker/get-apps/) — `POST /mod/docker/com/get_apps/stype`
- [查询应用的依赖是否已安装](https://docs.bt.cn/api/docker/get-dependence-apps/) — `POST /mod/docker/com/get_dependence_apps/stype`
- [初始化 Docker 应用商店环境](https://docs.bt.cn/api/docker/install-apphub/) — `POST /mod/docker/com/install_apphub/stype`

## [Java 项目](https://docs.bt.cn/api/tags/Java/)

Java 项目

- [为 Java 项目添加反向代理规则](https://docs.bt.cn/api/java/add-server-proxy/) — `GET /mod/java/project/add_server_proxy/stype`
- [为 Java 项目开放外网映射（生成 Nginx 配置文件）](https://docs.bt.cn/api/java/bind-extranet/) — `GET /mod/java/project/bind_extranet/stype`
- [修改 Java 项目的日志存储路径](https://docs.bt.cn/api/java/change-log-path/) — `GET /mod/java/project/change_log_path/stype`
- [检查 jar 文件的环境变量和配置](https://docs.bt.cn/api/java/check-env-for-project/) — `GET /mod/java/project/check_env_for_project/stype`
- [校验 Spring Boot 项目的创建参数](https://docs.bt.cn/api/java/check-spring-boot-args/) — `GET /mod/java/project/check_spring_boot_args/stype`
- [获取 Java 项目的配置文件列表](https://docs.bt.cn/api/java/config-file-list/) — `GET /mod/java/project/config_file_list/stype`
- [创建 Tomcat 类型的 Java 项目](https://docs.bt.cn/api/java/create-tomcat-project/) — `GET /mod/java/project/create_tomcat_project/stype`
- [修复 Java 项目的配置](https://docs.bt.cn/api/java/fix-project/) — `GET /mod/java/project/fix_project/stype`
- [强制停止 Java 项目进程](https://docs.bt.cn/api/java/force-stop/) — `GET /mod/java/project/force_stop/stype`
- [获取 Java 项目的 JMX 监控状态](https://docs.bt.cn/api/java/get-jmx-status/) — `GET /mod/java/project/get_jmx_status/stype`
- [获取 Java 项目的更新任务状态](https://docs.bt.cn/api/java/get-keep-status/) — `GET /mod/java/project/get_keep_status/stype`
- [获取 Java 项目的系统负载信息](https://docs.bt.cn/api/java/get-load-info/) — `GET /mod/java/project/get_load_info/stype`
- [获取 Java 项目的详细信息](https://docs.bt.cn/api/java/get-project-info/) — `GET /mod/java/project/get_project_info/stype`
- [读取 Spring Boot 项目的日志文件内容](https://docs.bt.cn/api/java/get-spring-log-data/) — `GET /mod/java/project/get_spring_log_data/stype`
- [获取 Spring Boot 项目的日志文件列表](https://docs.bt.cn/api/java/get-spring-log-list/) — `GET /mod/java/project/get_spring_log_list/stype`
- [获取 Java 运行环境状态 — JDK 版本、Tomcat 版本](https://docs.bt.cn/api/java/get-system-info/) — `GET /mod/java/project/get_system_info/stype`
- [获取已安装的 Tomcat 版本及运行状态](https://docs.bt.cn/api/java/get-tomcat-list/) — `GET /mod/java/project/get_tomcat_list/stype`
- [获取 Java 项目的版本备份列表](https://docs.bt.cn/api/java/get-version-list/) — `GET /mod/java/project/get_version_list/stype`
- [异步安装指定版本的 JDK](https://docs.bt.cn/api/java/install-jdk-new/) — `GET /mod/java/project/install_jdk_new/stype`
- [异步安装指定版本的 Tomcat](https://docs.bt.cn/api/java/install-tomcat-new/) — `GET /mod/java/project/install_tomcat_new/stype`
- [更新任务管理（使用新版/使用旧版/停止新版）](https://docs.bt.cn/api/java/keep-option/) — `GET /mod/java/project/keep_option/stype`
- [修改 Java 项目的配置](https://docs.bt.cn/api/java/modify-project/) — `GET /mod/java/project/modify_project/stype`
- [修改 Tomcat 的配置（端口、用户、JDK、备注等）](https://docs.bt.cn/api/java/modify-tomcat/) — `GET /mod/java/project/modify_tomcat/stype`
- [为 Java 项目创建版本备份](https://docs.bt.cn/api/java/now-file-backup/) — `GET /mod/java/project/now_file_backup/stype`
- [获取运行中 Java 进程的信息，用于导入已有项目](https://docs.bt.cn/api/java/process-info-for-create/) — `GET /mod/java/project/process_info_for_create/stype`
- [获取 Java 项目绑定的域名列表](https://docs.bt.cn/api/java/project-domain-list/) — `GET /mod/java/project/project_domain_list/stype`
- [获取所有 Java 项目列表及运行状态](https://docs.bt.cn/api/java/project-list/) — `GET /mod/java/project/project_list/stype`
- [删除 Java 项目（不删除文件）](https://docs.bt.cn/api/java/remove-project/) — `GET /mod/java/project/remove_project/stype`
- [删除 Java 项目的反向代理规则](https://docs.bt.cn/api/java/remove-server-proxy/) — `GET /mod/java/project/remove_server_proxy/stype`
- [删除 Java 项目的版本备份](https://docs.bt.cn/api/java/remove-version/) — `GET /mod/java/project/remove_version/stype`
- [重启 Java 项目](https://docs.bt.cn/api/java/restart-project/) — `GET /mod/java/project/restart_project/stype`
- [获取 Java 项目的反向代理规则列表](https://docs.bt.cn/api/java/server-proxy-list/) — `GET /mod/java/project/server_proxy_list/stype`
- [设置 Java 项目的日志记录开关](https://docs.bt.cn/api/java/set-project-log-status/) — `GET /mod/java/project/set_project_log_status/stype`
- [为 Spring Boot 项目设置静态文件路径](https://docs.bt.cn/api/java/set-static-path/) — `GET /mod/java/project/set_static_path/stype`
- [修改 Java 项目版本备份的备注](https://docs.bt.cn/api/java/set-version-ps/) — `GET /mod/java/project/set_version_ps/stype`
- [启动 Java 项目](https://docs.bt.cn/api/java/start-project/) — `GET /mod/java/project/start_project/stype`
- [启动 Tomcat 项目](https://docs.bt.cn/api/java/start-tomcat/) — `GET /mod/java/project/start_tomcat/stype`
- [停止 Java 项目](https://docs.bt.cn/api/java/stop-project/) — `GET /mod/java/project/stop_project/stype`
- [取消 Java 项目的外网映射](https://docs.bt.cn/api/java/unbind-extranet/) — `GET /mod/java/project/unbind_extranet/stype`
- [在已有网站下创建 Tomcat 项目（内嵌模式）](https://docs.bt.cn/api/java/create-site-tomcat-project/) — `POST /mod/java/project/create_site_tomcat_project/stype`
- [创建 Spring Boot Java 项目，支持绑定域名](https://docs.bt.cn/api/java/create-spring-boot-project/) — `POST /mod/java/project/create_spring_boot_project/stype`
- [批量删除 Java 项目](https://docs.bt.cn/api/java/multi-remove-project/) — `POST /mod/java/project/multi_remove_project/stype`
- [批量启动/停止 Java 项目](https://docs.bt.cn/api/java/multi-set-project/) — `POST /mod/java/project/multi_set_project/stype`

## [ACME 证书](https://docs.bt.cn/api/tags/ACME/)

ACME 证书

- [ACME 证书：按 action 选择功能](https://docs.bt.cn/api/acme/actions/) — `POST /acme`

## [计划任务](https://docs.bt.cn/api/tags/tag-1am3amu/)

计划任务

- [计划任务：按 action 选择功能](https://docs.bt.cn/api/crontab/actions/) — `POST /crontab`

## [数据查询](https://docs.bt.cn/api/tags/tag-sxj2lc/)

数据查询

- [查询面板 SQLite 数据表（sites、databases、ftps、domain 等）](https://docs.bt.cn/api/data/get-data/) — `POST /data`

## [数据库管理](https://docs.bt.cn/api/tags/tag-dost67/)

数据库管理

- [数据库管理：按 action 选择功能](https://docs.bt.cn/api/database/actions/) — `POST /database`

## [项目部署](https://docs.bt.cn/api/tags/tag-pfih34/)

项目部署

- [项目部署：按 action 选择功能](https://docs.bt.cn/api/deployment/actions/) — `POST /deployment`

## [文件管理](https://docs.bt.cn/api/tags/tag-1vgdqjj/)

文件管理

- [文件管理：按 action 选择功能](https://docs.bt.cn/api/files/actions/) — `POST /files`

## [FTP 管理](https://docs.bt.cn/api/tags/FTP/)

FTP 管理

- [FTP 管理：按 action 选择功能](https://docs.bt.cn/api/ftp/actions/) — `POST /ftp`

## [Proxy 反向代理](https://docs.bt.cn/api/tags/Proxy/)

Proxy 反向代理

- [Proxy 反向代理：按 action 选择功能](https://docs.bt.cn/api/proxy/actions/) — `POST /mod/proxy/com/{action}/stype`
- [为已有反向代理站点添加新的代理规则](https://docs.bt.cn/api/proxy/add-proxy/) — `POST /mod/proxy/com/add_proxy/stype`
- [清除反向代理站点缓存](https://docs.bt.cn/api/proxy/clear-cache/) — `POST /mod/proxy/com/clear_cache/stype`
- [创建反向代理站点](https://docs.bt.cn/api/proxy/create/) — `POST /mod/proxy/com/create/stype`
- [删除反向代理站点](https://docs.bt.cn/api/proxy/delete/) — `POST /mod/proxy/com/delete/stype`
- [获取指定站点的域名列表及 HTTPS 端口](https://docs.bt.cn/api/proxy/get-domain-list/) — `POST /mod/proxy/com/get_domain_list/stype`
- [获取反向代理站点的全局配置信息](https://docs.bt.cn/api/proxy/get-global-conf/) — `POST /mod/proxy/com/get_global_conf/stype`
- [获取所有反向代理站点列表，支持分页和搜索](https://docs.bt.cn/api/proxy/get-list/) — `POST /mod/proxy/com/get_list/stype`
- [获取指定站点的所有反向代理规则列表](https://docs.bt.cn/api/proxy/get-proxy-list/) — `POST /mod/proxy/com/get_proxy_list/stype`
- [获取反向代理站点日志](https://docs.bt.cn/api/proxy/get-site-logs/) — `POST /mod/proxy/com/GetSiteLogs/stype`
- [设置反向代理站点全局缓存](https://docs.bt.cn/api/proxy/set-global-cache/) — `POST /mod/proxy/com/set_global_cache/stype`
- [设置反向代理站点全局 Gzip 压缩](https://docs.bt.cn/api/proxy/set-global-gzip/) — `POST /mod/proxy/com/set_global_gzip/stype`
- [设置反向代理站点日志配置](https://docs.bt.cn/api/proxy/set-global-log/) — `POST /mod/proxy/com/set_global_log/stype`
- [设置反向代理站点 WebSocket 支持](https://docs.bt.cn/api/proxy/set-global-websocket/) — `POST /mod/proxy/com/set_global_websocket/stype`
- [设置反向代理站点备注](https://docs.bt.cn/api/proxy/set-remak/) — `POST /mod/proxy/com/set_remak/stype`
- [启用或停用反向代理站点](https://docs.bt.cn/api/proxy/set-site-stop/) — `POST /mod/proxy/com/set_site_stop/stype`

## [密码管理](https://docs.bt.cn/api/tags/tag-11hbrh3/)

密码管理

- [获取面板密码/SSH密钥认证配置](https://docs.bt.cn/api/password/get-config/) — `POST /password`

## [消息推送](https://docs.bt.cn/api/tags/tag-1mup9yr/)

消息推送

- [消息推送：按 action 选择功能](https://docs.bt.cn/api/push/actions/) — `POST /push`

## [网站管理](https://docs.bt.cn/api/tags/tag-riltys/)

网站管理

- [网站管理：按 action 选择功能](https://docs.bt.cn/api/site/actions/) — `POST /site`

## [SSH 安全 - security](https://docs.bt.cn/api/tags/SSH-security/)

SSH 安全

- [SSH 安全：按 action 选择功能](https://docs.bt.cn/api/ssh-security/actions/) — `POST /ssh_security`

## [SSL 证书](https://docs.bt.cn/api/tags/SSL/)

SSL 证书

- [SSL 证书：按 action 选择功能](https://docs.bt.cn/api/ssl/actions/) — `POST /ssl`
- [添加 DNS 提供商的 API 密钥，用于 SSL 证书的 DNS 验证](https://docs.bt.cn/api/ssl/add-dns-data/) — `POST /ssl/dnsapi/add_dns_data`
- [删除已有的 DNS API 密钥配置](https://docs.bt.cn/api/ssl/del-dns-data/) — `POST /ssl/dnsapi/del_dns_data`
- [获取已配置的 DNS API 密钥列表及支持的 DNS 提供商](https://docs.bt.cn/api/ssl/get-dns-data/) — `POST /ssl/dnsapi/get_dns_data`
- [修改已有的 DNS API 密钥配置](https://docs.bt.cn/api/ssl/upd-dns-data/) — `POST /ssl/dnsapi/upd_dns_data`

## [系统管理](https://docs.bt.cn/api/tags/tag-1hdwiac/)

系统管理

- [系统管理：按 action 选择功能](https://docs.bt.cn/api/system/actions/) — `POST /system`

## [后台任务](https://docs.bt.cn/api/tags/tag-1928ovv/)

后台任务

- [获取后台任务队列列表](https://docs.bt.cn/api/task/get-task-lists/) — `POST /task`

## [安全扫描](https://docs.bt.cn/api/tags/tag-umyf9y/)

安全扫描

- [获取安全扫描结果列表](https://docs.bt.cn/api/warning/get-list/) — `POST /warning`

## [SSH 终端 - terminal](https://docs.bt.cn/api/tags/SSH-terminal/)

SSH 终端

- [获取 Web SSH 终端配置（命令补全、终端主题、AI Shell）](https://docs.bt.cn/api/xterm/completion-tool-status/) — `POST /xterm`


## API 概览

## 宝塔面板 API 概览

> **注意**：API 接口可能随面板版本变更，**不保证稳定性**，仅供参考。


> 基于面板 v11.7.0 源码实测验证，测试环境 Debian 13。

## 概述

| 项目 | 值 |
|------|-----|
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded |
| 认证方式 | 双重 MD5 签名 |

## 认证

面板设置 → API 接口 → 获取**接口密钥** `api_sk`。

```python
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/](https://docs.bt.cn/api/system) |
| 网站管理 | `/site` | [site/](https://docs.bt.cn/api/site) |
| 数据库管理 | `/database` | [database/](https://docs.bt.cn/api/database) |
| 文件管理 | `/files` | [files/](https://docs.bt.cn/api/files) |
| SSL 证书 | `/ssl` | [ssl/](https://docs.bt.cn/api/ssl) |
| ACME 证书 | `/acme` | [acme/](https://docs.bt.cn/api/acme) |
| Java 项目 | `/mod/java/project/` | [java/](https://docs.bt.cn/api/java) |
| 计划任务 | `/crontab` | [crontab/](https://docs.bt.cn/api/crontab) |
| FTP 管理 | `/ftp` | [ftp/](https://docs.bt.cn/api/ftp) |
| SSH 安全 | `/ssh_security` | [ssh_security/](https://docs.bt.cn/api/ssh_security) |
| 消息推送 | `/push` | [push/](https://docs.bt.cn/api/push) |
| 后台任务 | `/task` | [task/](https://docs.bt.cn/api/task) |
| SSH 终端 | `/xterm` | [xterm/](https://docs.bt.cn/api/xterm) |
| 数据查询 | `/data` | [data/](https://docs.bt.cn/api/data) |
| 安全扫描 | `/warning` | [warning/](https://docs.bt.cn/api/warning) |
| 密码管理 | `/password` | [password/](https://docs.bt.cn/api/password) |
| 项目部署 | `/deployment` | [deployment/](https://docs.bt.cn/api/deployment) |

