跳到主要内容

379 篇文档带有标签「API 接口」

查看所有标签

ACME 证书

宝塔面板 ACME 证书 API — Let's Encrypt 免费 SSL 证书申请、DNS 验证、部署

ActionTask

激活后台任务队列,开始处理积压的文件操作任务

add_dns_data

添加 DNS 提供商的 API 密钥,用于 SSL 证书的 DNS 验证

add_proxy

为已有反向代理站点添加新的代理规则

AddCrontab

创建计划任务(Shell 脚本、URL 请求、数据库备份等)

AddSite

创建新网站(PHP / 纯静态)

apply_cert_api

创建 ACME 证书申请订单(支持 HTTP/TLS/DNS 三种验证方式)

apply_dns_auth

通过已配置的 DNS API 自动创建 TXT 验证记录,完成域名验证并签发证书

bind_extranet

为 Java 项目开放外网映射(生成 Nginx 配置文件)

BinLog

管理 MySQL 二进制日志(开启/关闭/查看/清理)

ClearSystem

清理系统垃圾文件(临时文件、邮件队列等)

create

创建反向代理站点

create_app

从 Docker 应用商店安装应用(参数来源于 get_apps 返回值)

create_default_conf

获取创建网站时的默认配置项(404页面、默认首页、日志切割等)

CreateLink

创建文件或目录的软链接(符号链接)

delete

删除反向代理站点

DeleteDir

删除文件或目录(移到回收站)

DelLogs

清空指定计划任务的执行日志

Docker

宝塔面板 Docker API — 容器、镜像、网络、存储卷、Compose 管理、应用商店

FTP 管理

宝塔面板 FTP 管理 API — FTP 用户创建、删除、密码修改与端口设置

get_action_logs

获取 FTP 用户的操作日志(上传/下载/重命名/删除)

get_apps (Docker)

获取 Docker 应用商店的所有可用应用列表(含参数定义)

get_cert_list

获取已保存到本地的 SSL 证书列表(含详细信息)

get_config

获取 SSH 安全配置(密钥认证、root 登录、密码登录状态)

get_dns_data

获取已配置的 DNS API 密钥列表及支持的 DNS 提供商

get_domain

获取所有网站的域名列表(用于计划任务选择)

get_list

获取所有反向代理站点列表,支持分页和搜索

get_modules_list

获取消息推送模块列表(邮件、钉钉、飞书、微信等)

get_order_find

获取单个商用 SSL 证书订单的详细信息(含证书)

get_push_list

获取推送规则列表(流量告警、站点告警等)

get_Scan

获取网站漏洞扫描结果缓存

get_system_info

获取 Java 运行环境状态 — JDK 版本、Tomcat 版本

get_zone

获取系统支持的时区列表

GetAllInfo

获取系统全部信息概览(CPU、内存、负载、网络、磁盘)

GetCertList

获取面板中所有已部署的 SSL 证书列表

GetConcifInfo

获取面板完整环境配置(Web服务器、PHP、MySQL、Redis等组件状态)

GetConfig

获取面板密码/SSH密钥认证配置

GetCpuInfo

获取 CPU 使用率、核心数、各核使用率等信息

getData

查询面板 SQLite 数据表(sites、databases、ftps、domain 等)

GetDatabaseList

获取 MySQL 服务器上所有数据库列表(SHOW DATABASES)

GetDatabasesList

获取面板中管理的数据库列表(来自 SQLite databases 表)

GetDataList

按类型获取数据列表(网站/数据库等,用于计划任务配置)

GetDbStatus

获取 MySQL 内存配置参数(从 /etc/my.cnf 解析)

GetDir

获取指定目录的文件列表(含分页、排序、搜索)

GetDirNew

获取目录文件列表(新版),支持分页、搜索

GetDirUserINI

获取网站目录保护配置(防跨站、日志、Git 同步状态)

GetDiskInfo

获取磁盘分区信息(容量、使用率、inode、文件系统类型)

GetDnsApi

获取支持的 DNS API 提供商列表(CloudFlare、阿里云、DNSPod 等)

GetErrorLog

获取 MySQL 错误日志文件路径和内容

GetHasPwd

查看网站密码访问保护状态

GetIndex

获取网站的默认文档设置

GetInfo

获取面板管理的数据库详情(数据大小、表数量)

GetInLog

获取一键部署任务的执行日志

GetLimitNet

获取网站的流量限制配置(并发、IP、速率)

GetList

获取一键部署的软件包列表

GetLoadAverage

获取系统负载均值(1分钟、5分钟、15分钟)

GetLoginFailed

获取 MySQL 登录失败跟踪(Connection Control)插件状态

GetLogs

获取计划任务的执行日志

GetMemInfo

获取内存详细信息(总量、空闲、缓存、可用、实际使用)

GetMySQLInfo

获取 MySQL 基本配置信息(数据目录、端口)

GetNetWork

获取实时网络流量、CPU、内存、磁盘、负载等综合系统数据

GetRunStatus

获取 MySQL 运行状态变量(SHOW GLOBAL STATUS)

GetSiteDomain

获取可用于 SSL 证书申请的站点域名列表

GetSiteList

获取可用于部署的网站列表及支持的框架

GetSpeed

获取一键部署任务的执行进度

GetSSL

获取网站的 SSL 证书信息(证书状态、域名、TLS 版本配置)

GetSSLProduct

获取 SSL 证书产品列表(含价格和折扣)

GetSystemTotal

获取系统统计信息(内存、CPU、运行时间、系统版本)

Java 项目

宝塔面板 Java 项目管理 API — JDK/Tomcat 安装、Spring Boot 项目创建启停、SSL 部署

keep_option

更新任务管理(使用新版/使用旧版/停止新版)

list

获取网站漏洞扫描的缓存结果

list_backups

获取已配置的云存储备份列表(七牛/阿里云OSS/百度云等)

modify_tomcat

修改 Tomcat 的配置(端口、用户、JDK、备注等)

multiple_basedir

批量为多个网站设置防跨站攻击(open_basedir)状态

open_cdn_ip

开启 CDN IP 获取(从 X-Forwarded-For 等头获取真实 IP)

RemoveTask

删除指定的后台任务(文件操作队列)

send_baota

提交 Webshell 误报反馈给宝塔官方

ServiceAdmin

管理服务启停(Nginx、MySQL、PHP、Redis、Pure-FTPd 等)

set_cert

将商用 SSL 证书订单中的证书部署到指定网站

SetLimitNet

设置网站流量限制和并发连接限制

setPort

修改 FTP 服务监听端口

SetSSL

为网站部署自定义 SSL 证书

SetSSLConf

为网站开启 SSL 并批量部署证书(兼容多项目类型)

SiteStop

停止网站(将网站设为停用状态)

SSH 安全

宝塔面板 SSH 安全 API — SSH 配置查询与安全漏洞扫描

SSH 终端

宝塔面板 SSH 终端 API — Web SSH 终端配置查询

SSL 证书

宝塔面板 SSL 证书 API — 商用证书、证书管理、DNS API 密钥配置

test_path

检测路径是否存在,返回路径类型信息

UploadFile

上传文件到服务器(multipart/form-data)

后台任务

宝塔面板后台任务 API — 查询面板异步任务队列执行状态

安全扫描

宝塔面板安全扫描 API — 获取安全扫描结果与告警记录

密码管理

宝塔面板密码管理 API — 面板密码与 SSH 密钥认证配置查询

数据库管理

宝塔面板数据库管理 API — MySQL 数据库创建、备份、用户权限管理

数据查询

宝塔面板数据查询 API — 直接查询面板内置 SQLite 数据库表数据

文件管理

宝塔面板文件管理 API — 文件上传、复制、读取与目录浏览

消息推送

宝塔面板消息推送 API — 告警推送配置

系统管理

宝塔面板系统管理 API — 获取系统状态、管理服务启停

网站管理

宝塔面板网站管理 API — 网站创建、SSL/HTTPS 配置、域名绑定与流量管理

计划任务

宝塔面板计划任务 API — 创建、修改、删除和查询 Cron 定时任务

项目部署

宝塔面板一键部署 API — 软件包列表、环境检测、部署管理