宝塔面板如何通过宝塔API实现自动化管理_调用接入文档

千静君_8135

千静君_8135

2026-03-23

1154人浏览

原创

宝塔API需先在面板设置中开启并生成密钥,调用时必须用key、secret、时间戳、路径及排序后参数拼接签名;仅支持HTTPS,超时建议设30秒以上,路径须规范。

宝塔面板如何通过宝塔api实现自动化管理_调用接入文档

宝塔API怎么开启和获取密钥

不开启API,所有自动化都无从谈起。默认安装后API是关闭的,且没有密钥——直接调用会返回 {"code":400,"msg":"API未开启"}。

操作路径:面板首页 → 「设置」→ 「面板设置」→ 拉到底部勾选「开启API接口」→ 点击「保存」→ 再点「API密钥管理」生成新密钥。

  • 生成后务必复制保存 key 和 secret,页面刷新后 secret 不再显示(无法找回)
  • key 是公开的,secret 必须严格保密,别硬编码进前端或Git仓库
  • 如果误删密钥,只能重新生成,旧脚本会立刻失效

调用API前必须算签名(sign)

宝塔API不是简单带token的REST请求,每次请求都要在URL里带上动态 sign 参数,它是用 key、secret、当前时间戳(秒级)、请求路径和参数拼起来SHA256加密的结果。

漏掉时间戳校验或签名错一位,就会返回 {"code":401,"msg":"签名错误"},这是最常卡住人的地方。

  • 时间戳必须是UTC+8的秒级整数(int(time.time())),不能带毫秒,服务器时间误差超过5分钟也会失败
  • 拼接字符串顺序固定:key + secret + timestamp + path + ? + query_string(按字母序排序参数)
  • GET请求的参数要参与签名;POST的body数据(如JSON)不参与,但path和query仍要算

示例(Python):
sign = hashlib.sha256((key + secret + str(timestamp) + path + '?' + 'app_name=nginx&status=start').encode()).hexdigest()

常见操作对应的关键接口和参数

别盲目翻文档,高频动作就那几个,直接记住路径和必填字段更省事:

  • 重启网站:/site/restart_site,POST body需含 {"siteName": "example.com"}
  • 获取PHP版本列表:/php/get_php_version,GET即可,不用传参数
  • 添加计划任务:/crontab/add_crontab,POST body里 name、type(hour/day等)、where1(具体时间值)、sname(脚本路径或命令)都不能为空
  • 查MySQL数据库列表:/database/get_database_list,GET加 type=mysql 查询参数

注意:/ssl/get_ssl_list 返回的是证书ID而非域名,要查某个域名是否已部署SSL,得先用 /site/get_sites 拿站点列表,再逐个看 ssl_id 字段。

HTTPS、超时、错误码这些实际跑起来才踩的坑

本地测试通了,一上生产就报错?大概率是这几个点没对齐:

  • 宝塔API只支持HTTPS请求,HTTP会直接被Nginx 301跳转,导致签名失效(跳转后URL变了,sign没重算)
  • 默认超时是3秒,执行慢的操作(比如备份大网站)容易触发 {"code":504,"msg":"网关超时"},建议客户端设成30秒以上
  • code 为0才是成功,非0不全是错误——比如 {"code":1001,"msg":"站点不存在"} 是业务提示,不是网络异常
  • 部分接口(如 /files/get_files_list)要求路径用正斜杠且以 /www/wwwroot/ 开头,传 ../ 或反斜杠会返回空列表不报错

签名逻辑、时间同步、HTTPS强制、路径规范——这四点没对齐,90%的“调不通”问题就出在这儿。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

120

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

60

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

120

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

100

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

100

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

100

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习