# api ## Pages - [宝塔面板 API 参考](https://docs.bt.cn/api/index.md) — 根据宝塔面板 API 文档整理。接口可能随面板版本变更，不保证稳定；按真实请求地址查看接口，具体 action 的参数和示例见各接口页。 - [ACME 证书：按 action 选择功能](https://docs.bt.cn/api/acme/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [计划任务：按 action 选择功能](https://docs.bt.cn/api/crontab/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [查询面板 SQLite 数据表（sites、databases、ftps、domain 等）](https://docs.bt.cn/api/data/get-data/index.md) — 查询面板 SQLite 数据库中的任意表，支持搜索、分页、排序。这是获取各类资源 ID 的核心接口。 - [数据库管理：按 action 选择功能](https://docs.bt.cn/api/database/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [项目部署：按 action 选择功能](https://docs.bt.cn/api/deployment/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [创建 Docker 存储卷](https://docs.bt.cn/api/docker/add-volume/index.md) — 创建新的 Docker 数据卷。 - [从 Docker 应用商店安装应用（参数来源于 get_apps 返回值）](https://docs.bt.cn/api/docker/create-app/index.md) — 从应用商店安装 Docker 应用（如 WordPress、MySQL、Redis 等）。 - [创建 Docker 网络](https://docs.bt.cn/api/docker/create-network/index.md) — 创建新的 Docker 网络。 - [获取 Docker 应用商店的 Git 配置](https://docs.bt.cn/api/docker/get-apphub-config/index.md) — 获取 Docker 应用商店的 Git 仓库配置信息。 - [获取 Docker 应用商店的所有可用应用列表（含参数定义）](https://docs.bt.cn/api/docker/get-apps/index.md) — 获取 Docker 应用商店中所有可安装的应用列表，共 289 个。**每个应用的 `env` 和 `field` 字段定义了安装时需要的参数**。 - [获取容器执行命令的日志](https://docs.bt.cn/api/docker/get-cmd-log/index.md) — 获取指定容器内执行命令的实时日志输出。 - [获取 Docker 的安装状态和配置](https://docs.bt.cn/api/docker/get-config/index.md) — 获取 Docker 和 Docker Compose 的安装状态以及 Docker 服务运行状态。 - [查询应用的依赖是否已安装](https://docs.bt.cn/api/docker/get-dependence-apps/index.md) — 查询指定应用所需的依赖应用（如数据库）是否已安装。 - [获取 Docker 网络列表](https://docs.bt.cn/api/docker/get-host-network/index.md) — 获取 Docker 宿主机上的所有网络（bridge、host、none 及自定义网络）。 - [获取所有 Docker 容器列表及运行状态](https://docs.bt.cn/api/docker/get-list/index.md) — 获取 Docker 宿主机上所有容器的列表及系统资源信息。 - [获取 Docker Compose 项目列表](https://docs.bt.cn/api/docker/get-project-list/index.md) — 获取通过 Docker Compose 部署的项目列表。 - [获取 Docker 镜像加速器配置](https://docs.bt.cn/api/docker/get-registry-mirrors/index.md) — 获取已配置的 Docker 镜像加速地址。 - [获取 Docker 存储卷列表](https://docs.bt.cn/api/docker/get-volume-list/index.md) — 获取 Docker 宿主机上所有数据卷。 - [获取本地 Docker 镜像列表](https://docs.bt.cn/api/docker/image-list/index.md) — 获取 Docker 宿主机上已下载的所有镜像。 - [初始化 Docker 应用商店环境](https://docs.bt.cn/api/docker/install-apphub/index.md) — 初始化 Docker 应用商店的运行环境。 - [安装 Docker 和 Docker Compose（异步任务）](https://docs.bt.cn/api/docker/install-docker-program/index.md) — 提交 Docker 和 Docker Compose 的安装任务到后台队列，异步执行。 - [清理所有已停止的无用容器](https://docs.bt.cn/api/docker/prune-container/index.md) — 清理 Docker 宿主机上所有已停止的无用容器。 - [清理所有无用的 Docker 镜像](https://docs.bt.cn/api/docker/prune-image/index.md) — 清理 Docker 宿主机上未被任何容器使用的悬空镜像。 - [清理无用的 Docker 网络](https://docs.bt.cn/api/docker/prune-network/index.md) — 清理未被任何容器使用的 Docker 网络。 - [获取 Docker 镜像仓库列表](https://docs.bt.cn/api/docker/registry-list/index.md) — 获取已配置的 Docker 镜像仓库（Registry）列表。 - [重启 Docker 容器](https://docs.bt.cn/api/docker/restart/index.md) — 重启指定的 Docker 容器。 - [搜索 Docker Hub 上的镜像](https://docs.bt.cn/api/docker/search-image/index.md) — 搜索 Docker Hub 上的公开镜像。 - [设置 Docker 监控数据的保留天数](https://docs.bt.cn/api/docker/set-monitor-save-date/index.md) — 设置 Docker 容器监控数据的保留天数。 - [设置 Docker 官方镜像加速器地址](https://docs.bt.cn/api/docker/set-registry-mirrors/index.md) — 设置 Docker 的官方 registry 镜像加速地址。 - [设置 Docker 镜像仓库的备注](https://docs.bt.cn/api/docker/set-remark/index.md) — 修改已配置的 Docker Registry 的备注信息。 - [启动已停止的 Docker 容器](https://docs.bt.cn/api/docker/start/index.md) — 启动指定的 Docker 容器。 - [停止运行中的 Docker 容器](https://docs.bt.cn/api/docker/stop/index.md) — 停止指定的 Docker 容器。 - [获取 Docker Compose 模板列表](https://docs.bt.cn/api/docker/template-list/index.md) — 获取可用的 Docker Compose 项目模板。 - [文件管理：按 action 选择功能](https://docs.bt.cn/api/files/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [FTP 管理：按 action 选择功能](https://docs.bt.cn/api/ftp/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [为 Java 项目添加反向代理规则](https://docs.bt.cn/api/java/add-server-proxy/index.md) — 为指定 Java 项目添加反向代理规则。 - [为 Java 项目开放外网映射（生成 Nginx 配置文件）](https://docs.bt.cn/api/java/bind-extranet/index.md) — 为 Java 项目生成 Nginx 反向代理配置文件，开放外网访问。**部署 SSL 证书前必须执行此步骤**。 - [修改 Java 项目的日志存储路径](https://docs.bt.cn/api/java/change-log-path/index.md) — 修改 Java 项目的日志文件存储路径。 - [检查 jar 文件的环境变量和配置](https://docs.bt.cn/api/java/check-env-for-project/index.md) — 检查指定 jar 包的 Spring Boot 配置，检测潜在的环境问题。 - [校验 Spring Boot 项目的创建参数](https://docs.bt.cn/api/java/check-spring-boot-args/index.md) — 在创建 Spring Boot 项目前校验参数的合法性，返回处理后的参数对象或错误描述。 - [获取 Java 项目的配置文件列表](https://docs.bt.cn/api/java/config-file-list/index.md) — 获取 Java 项目关联的配置文件列表。 - [在已有网站下创建 Tomcat 项目（内嵌模式）](https://docs.bt.cn/api/java/create-site-tomcat-project/index.md) — 在已有网站目录下创建 Tomcat 项目。需通过 POST body `data` 参数传递 JSON。 - [创建 Spring Boot Java 项目，支持绑定域名](https://docs.bt.cn/api/java/create-spring-boot-project/index.md) — 将已有的 Spring Boot jar 包创建为面板管理的 Java 项目，支持开机启动、日志管理和状态监控。 - [创建 Tomcat 类型的 Java 项目](https://docs.bt.cn/api/java/create-tomcat-project/index.md) — 基于已安装的 Tomcat 创建 Java Web 项目。 - [修复 Java 项目的配置](https://docs.bt.cn/api/java/fix-project/index.md) — 修复 Java 项目的配置文件，恢复默认设置。 - [强制停止 Java 项目进程](https://docs.bt.cn/api/java/force-stop/index.md) — 强制终止 Java 项目的所有相关进程（kill -9）。 - [获取 Java 项目的 JMX 监控状态](https://docs.bt.cn/api/java/get-jmx-status/index.md) — 检查指定 Spring Boot 项目是否已启用 JMX 监控。 - [获取 Java 项目的更新任务状态](https://docs.bt.cn/api/java/get-keep-status/index.md) — 查询是否有正在进行的项目更新任务。 - [获取 Java 项目的系统负载信息](https://docs.bt.cn/api/java/get-load-info/index.md) — 获取运行中 Java 项目的 CPU 和内存使用情况。 - [获取 Java 项目的详细信息](https://docs.bt.cn/api/java/get-project-info/index.md) — 获取指定 Java 项目的完整配置和运行信息。 - [读取 Spring Boot 项目的日志文件内容](https://docs.bt.cn/api/java/get-spring-log-data/index.md) — 读取 Spring Boot 项目的日志文件内容。 - [获取 Spring Boot 项目的日志文件列表](https://docs.bt.cn/api/java/get-spring-log-list/index.md) — 获取指定 Spring Boot 项目的日志文件列表。 - [获取 Java 运行环境状态 — JDK 版本、Tomcat 版本](https://docs.bt.cn/api/java/get-system-info/index.md) — 获取服务器上已安装和可安装的 JDK、Tomcat 版本信息。 - [获取已安装的 Tomcat 版本及运行状态](https://docs.bt.cn/api/java/get-tomcat-list/index.md) — 获取服务器上所有已安装 Tomcat 的版本、路径、端口和运行状态。 - [获取 Java 项目的版本备份列表](https://docs.bt.cn/api/java/get-version-list/index.md) — 获取指定 Java 项目的版本备份列表。 - [异步安装指定版本的 JDK](https://docs.bt.cn/api/java/install-jdk-new/index.md) — 提交 JDK 安装任务到后台队列，异步执行。通过消息盒子查看安装进度。 - [异步安装指定版本的 Tomcat](https://docs.bt.cn/api/java/install-tomcat-new/index.md) — 提交 Tomcat 安装任务到后台队列，异步执行。 - [更新任务管理（使用新版/使用旧版/停止新版）](https://docs.bt.cn/api/java/keep-option/index.md) — 在进行中的项目更新任务中，切换使用新版 jar、回退旧版或停止新版。 - [修改 Java 项目的配置](https://docs.bt.cn/api/java/modify-project/index.md) — 修改 Java 项目的运行配置（JDK、启动命令、端口、备注等）。 - [修改 Tomcat 的配置（端口、用户、JDK、备注等）](https://docs.bt.cn/api/java/modify-tomcat/index.md) — 修改已安装 Tomcat 的配置参数。 - [批量删除 Java 项目](https://docs.bt.cn/api/java/multi-remove-project/index.md) — 批量删除多个 Java 项目。需通过 POST body `data` 参数传递 JSON。 - [批量启动/停止 Java 项目](https://docs.bt.cn/api/java/multi-set-project/index.md) — 批量启动或停止多个 Java 项目。需通过 POST body `data` 参数传递 JSON。 - [为 Java 项目创建版本备份](https://docs.bt.cn/api/java/now-file-backup/index.md) — 为指定 Java 项目的当前文件创建版本备份。 - [获取运行中 Java 进程的信息，用于导入已有项目](https://docs.bt.cn/api/java/process-info-for-create/index.md) — 通过 PID 获取正在运行的 Java 进程的详细信息（端口、启动命令、环境变量等），用于将已有 Java 应用导入面板管理。 - [获取 Java 项目绑定的域名列表](https://docs.bt.cn/api/java/project-domain-list/index.md) — 获取指定 Java 项目已绑定的域名和端口映射。 - [获取所有 Java 项目列表及运行状态](https://docs.bt.cn/api/java/project-list/index.md) — 获取面板中所有 Java 项目（Spring Boot / Tomcat）的列表及运行状态。 - [删除 Java 项目（不删除文件）](https://docs.bt.cn/api/java/remove-project/index.md) — 从面板管理中移除 Java 项目（不删除实际的 jar 或项目文件）。 - [删除 Java 项目的反向代理规则](https://docs.bt.cn/api/java/remove-server-proxy/index.md) — 删除指定 Java 项目的某条反向代理规则。 - [删除 Java 项目的版本备份](https://docs.bt.cn/api/java/remove-version/index.md) — 删除指定版本备份。 - [重启 Java 项目](https://docs.bt.cn/api/java/restart-project/index.md) — 重启已创建的 Java 项目。 - [获取 Java 项目的反向代理规则列表](https://docs.bt.cn/api/java/server-proxy-list/index.md) — 获取指定 Java 项目已配置的所有反向代理规则。 - [设置 Java 项目的日志记录开关](https://docs.bt.cn/api/java/set-project-log-status/index.md) — 开启或关闭 Java 项目的日志记录，重启项目后生效。 - [为 Spring Boot 项目设置静态文件路径](https://docs.bt.cn/api/java/set-static-path/index.md) — 为 Spring Boot 项目配置静态文件目录和默认首页。 - [修改 Java 项目版本备份的备注](https://docs.bt.cn/api/java/set-version-ps/index.md) — 修改指定版本备份的备注信息。 - [启动 Java 项目](https://docs.bt.cn/api/java/start-project/index.md) — 启动已创建的 Java 项目。 - [启动 Tomcat 项目](https://docs.bt.cn/api/java/start-tomcat/index.md) — 启动 Tomcat 类型的 Java 项目。 - [停止 Java 项目](https://docs.bt.cn/api/java/stop-project/index.md) — 停止正在运行的 Java 项目。 - [取消 Java 项目的外网映射](https://docs.bt.cn/api/java/unbind-extranet/index.md) — 取消 Java 项目的外网映射。 - [获取面板密码/SSH密钥认证配置](https://docs.bt.cn/api/password/get-config/index.md) — 获取面板密码认证和 SSH 密钥认证的配置状态。 - [Proxy 反向代理：按 action 选择功能](https://docs.bt.cn/api/proxy/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [为已有反向代理站点添加新的代理规则](https://docs.bt.cn/api/proxy/add-proxy/index.md) — 为已有站点添加一条新的反向代理规则（location 块）。 - [清除反向代理站点缓存](https://docs.bt.cn/api/proxy/clear-cache/index.md) — 清除指定反向代理站点的代理缓存目录中的文件。 - [创建反向代理站点](https://docs.bt.cn/api/proxy/create/index.md) — 创建反向代理站点，生成 Nginx 配置文件、写入数据库、添加防火墙规则。 - [删除反向代理站点](https://docs.bt.cn/api/proxy/delete/index.md) — 删除指定反向代理站点，包括 Nginx 配置、日志、数据库记录。 - [获取指定站点的域名列表及 HTTPS 端口](https://docs.bt.cn/api/proxy/get-domain-list/index.md) — 获取站点的所有绑定域名及其健康状态、HTTPS 端口信息。 - [获取反向代理站点的全局配置信息](https://docs.bt.cn/api/proxy/get-global-conf/index.md) — 获取指定站点的完整 JSON 配置，包括域名、SSL、缓存、Gzip、WebSocket 等全局设置。 - [获取所有反向代理站点列表，支持分页和搜索](https://docs.bt.cn/api/proxy/get-list/index.md) — 获取所有 `project_type` 为 `proxy` 的站点列表，支持分页和搜索。 - [获取指定站点的所有反向代理规则列表](https://docs.bt.cn/api/proxy/get-proxy-list/index.md) — 获取指定站点在 JSON 配置文件中的所有反向代理规则。 - [获取反向代理站点日志](https://docs.bt.cn/api/proxy/get-site-logs/index.md) — 获取反向代理站点的访问日志文件和大小。 - [设置反向代理站点全局缓存](https://docs.bt.cn/api/proxy/set-global-cache/index.md) — 开启或关闭反向代理站点的全局代理缓存（静态资源缓存）。 - [设置反向代理站点全局 Gzip 压缩](https://docs.bt.cn/api/proxy/set-global-gzip/index.md) — 开启或关闭反向代理站点的全局 Gzip 压缩。 - [设置反向代理站点日志配置](https://docs.bt.cn/api/proxy/set-global-log/index.md) — 设置反向代理站点的全局日志类型。 - [设置反向代理站点 WebSocket 支持](https://docs.bt.cn/api/proxy/set-global-websocket/index.md) — 开启或关闭反向代理站点的 WebSocket 协议支持。 - [设置反向代理站点备注](https://docs.bt.cn/api/proxy/set-remak/index.md) — 方法名拼写为 `set_remak`（非 remark）。 - [启用或停用反向代理站点](https://docs.bt.cn/api/proxy/set-site-stop/index.md) — 启用（运行中）或停用（已停止）反向代理站点。 - [消息推送：按 action 选择功能](https://docs.bt.cn/api/push/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [网站管理：按 action 选择功能](https://docs.bt.cn/api/site/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [SSH 安全：按 action 选择功能](https://docs.bt.cn/api/ssh-security/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [SSL 证书：按 action 选择功能](https://docs.bt.cn/api/ssl/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [添加 DNS 提供商的 API 密钥，用于 SSL 证书的 DNS 验证](https://docs.bt.cn/api/ssl/add-dns-data/index.md) — 添加一个 DNS 提供商的 API 密钥配置，用于 Let's Encrypt 等证书的 DNS 验证方式自动申请和续签。 - [删除已有的 DNS API 密钥配置](https://docs.bt.cn/api/ssl/del-dns-data/index.md) — 删除指定 ID 的 DNS API 密钥配置。 - [获取已配置的 DNS API 密钥列表及支持的 DNS 提供商](https://docs.bt.cn/api/ssl/get-dns-data/index.md) — 获取所有已配置的 DNS API 密钥，以及当前面板支持的 DNS 提供商列表。 - [修改已有的 DNS API 密钥配置](https://docs.bt.cn/api/ssl/upd-dns-data/index.md) — 更新已有的 DNS API 密钥配置，可修改备注名称和密钥参数。 - [系统管理：按 action 选择功能](https://docs.bt.cn/api/system/actions/index.md) — 这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。 - [ACME 证书](https://docs.bt.cn/api/tags/ACME/index.md) — ACME 证书 - [Docker](https://docs.bt.cn/api/tags/Docker/index.md) — Docker - [FTP 管理](https://docs.bt.cn/api/tags/FTP/index.md) — FTP 管理 - [Java 项目](https://docs.bt.cn/api/tags/Java/index.md) — Java 项目 - [Proxy 反向代理](https://docs.bt.cn/api/tags/Proxy/index.md) — Proxy 反向代理 - [SSH 安全 - security](https://docs.bt.cn/api/tags/SSH-security/index.md) — SSH 安全 - [SSH 终端 - terminal](https://docs.bt.cn/api/tags/SSH-terminal/index.md) — SSH 终端 - [SSL 证书](https://docs.bt.cn/api/tags/SSL/index.md) — SSL 证书 - [密码管理](https://docs.bt.cn/api/tags/tag-11hbrh3/index.md) — 密码管理 - [后台任务](https://docs.bt.cn/api/tags/tag-1928ovv/index.md) — 后台任务 - [计划任务](https://docs.bt.cn/api/tags/tag-1am3amu/index.md) — 计划任务 - [系统管理](https://docs.bt.cn/api/tags/tag-1hdwiac/index.md) — 系统管理 - [消息推送](https://docs.bt.cn/api/tags/tag-1mup9yr/index.md) — 消息推送 - [文件管理](https://docs.bt.cn/api/tags/tag-1vgdqjj/index.md) — 文件管理 - [数据库管理](https://docs.bt.cn/api/tags/tag-dost67/index.md) — 数据库管理 - [项目部署](https://docs.bt.cn/api/tags/tag-pfih34/index.md) — 项目部署 - [网站管理](https://docs.bt.cn/api/tags/tag-riltys/index.md) — 网站管理 - [数据查询](https://docs.bt.cn/api/tags/tag-sxj2lc/index.md) — 数据查询 - [安全扫描](https://docs.bt.cn/api/tags/tag-umyf9y/index.md) — 安全扫描 - [获取后台任务队列列表](https://docs.bt.cn/api/task/get-task-lists/index.md) — 获取面板后台任务队列信息。 - [获取安全扫描结果列表](https://docs.bt.cn/api/warning/get-list/index.md) — 获取服务器的安全漏洞扫描结果。 - [获取 Web SSH 终端配置（命令补全、终端主题、AI Shell）](https://docs.bt.cn/api/xterm/completion-tool-status/index.md) — 获取 Web SSH 终端的当前配置。