宝塔面板官方文档

修改网站的备注名称（别名）

修改网站的备注名称/别名。

POST

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

更新于 2026年7月10日查看 Markdown

Request bodyX-WWW-FORM-URLENCODEDrequired

request_timestringrequired
Unix 时间戳。

request_tokenstringrequired
按 API 概览生成的签名。
actionsite_rnamerequired
具体操作名称。
idintegerrequired
网站 ID
rnamestringrequired
新的备注名称

Returns

default

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

JSON

statusoptionalboolean
true 修改成功

各操作详细说明

site_rnameaction=site_rname修改网站的备注名称（别名）

修改网站的备注名称/别名。

路由：POST /site
action：site_rname

输入参数

参数名称	必选	类型	描述
action	是	String	固定值 `site_rname`
id	是	Integer	网站 ID
rname	是	String	新的备注名称

输出参数

参数名称	类型	描述
status	Boolean	`true` 修改成功

示例

请求

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

action=site_rname&id=1&rname=我的网站

响应

{"status": true, "msg": "网站【testapi.bt.local】改名为：【我的网站】"}

修改网站的备注名称（别名）

curl --request POST \
  --url "https://your-panel.example.com:8888/site" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request_time=<Unix时间戳>" \
  --data-urlencode "request_token=<按 API 概览生成的签名>" \
  --data-urlencode "action=site_rname" \
  --data-urlencode "id=<id>" \
  --data-urlencode "rname=<rname>"

Response example

{
  "status": true,
  "msg": "网站【testapi.bt.local】改名为：【我的网站】"
}