Skip to content

为网站部署自定义 SSL 证书

为指定网站部署自定义 SSL 证书(PEM 格式)。面板会验证证书和私钥的匹配性、证书链完整性,验证通过后写入配置并重载 Web 服务器。

POST
https://your-panel.example.com:8888/site
更新于 查看 Markdown

Request bodyX-WWW-FORM-URLENCODEDrequired

  • request_timestringrequired

    Unix 时间戳。

  • request_tokenstringrequired

    按 API 概览生成的签名。

  • actionSetSSLrequired

    具体操作名称。

  • siteNamestringrequired

    网站域名

  • keystringrequired

    证书私钥(PEM 格式,含 -----BEGIN PRIVATE KEY-----)

  • csrstringrequired

    证书文件(PEM 格式,含 -----BEGIN CERTIFICATE-----)

Returns

default

接口响应,业务状态见下方详细说明。

JSON
  • statusoptionalboolean

    true 表示部署成功

  • msgoptionalstring

    证书已保存!

各操作详细说明

SetSSLaction=SetSSL为网站部署自定义 SSL 证书

为指定网站部署自定义 SSL 证书(PEM 格式)。面板会验证证书和私钥的匹配性、证书链完整性,验证通过后写入配置并重载 Web 服务器。

  • 路由:POST /site
  • action:SetSSL

输入参数

参数名称 必选 类型 描述
action 是 String 固定值 SetSSL
siteName 是 String 网站域名
key 是 String 证书私钥(PEM 格式,含 -----BEGIN PRIVATE KEY-----)
csr 是 String 证书文件(PEM 格式,含 -----BEGIN CERTIFICATE-----)

验证规则

  • key 必须包含 KEY
  • csr 必须包含 CERTIFICATE
  • 证书必须是有效的 PEM 格式
  • 私钥和证书必须互相对应匹配
  • 证书链必须完整

验证失败时返回具体错误提示。

输出参数

参数名称 类型 描述
status Boolean true 表示部署成功
msg String 证书已保存!

示例

生成自签名证书

openssl genrsa -out key.pem 2048
openssl req -new -x509 -key key.pem -out cert.pem -days 365 \
  -subj "/C=CN/ST=GD/L=SZ/O=Test/CN=testapi.bt.local"

请求

POST /site HTTP/1.1
Content-Type: application/x-www-form-urlencoded

action=SetSSL&siteName=testapi.bt.local&key=-----BEGIN PRIVATE KEY-----...&csr=-----BEGIN CERTIFICATE-----...

key 和 csr 中换行符 \n 需保留。

响应

{"status": true, "msg": "证书已保存!"}

相关接口

Navigation

Type to search…

↑↓ navigate↵ selectEsc close