Path: 宝塔面板 API 参考 › Proxy 反向代理

`POST /mod/proxy/com/add_proxy/stype`

为已有站点添加一条新的反向代理规则（location 块）。

## Request body

_Required._

- `opPostModProxyComAddProxyStype.request_time` (string, required) — Unix 时间戳；与接口密钥一起生成 request_token。
- `opPostModProxyComAddProxyStype.request_token` (string, required) — 按 API 概览中的双重 MD5 签名算法生成。
- `opPostModProxyComAddProxyStype.site_name` (string, required) — 站点名称
- `opPostModProxyComAddProxyStype.proxy_path` (string, required) — 代理路径，如 `/api`
- `opPostModProxyComAddProxyStype.proxy_pass` (string, required) — 代理目标 URL
- `opPostModProxyComAddProxyStype.proxy_host` (string, optional) — 代理 Host 头，默认 `$http_host`
- `opPostModProxyComAddProxyStype.proxy_type` (string, optional) — 代理类型，`http`（默认）或 `unix`
- `opPostModProxyComAddProxyStype.remark` (string, optional) — 备注

## Example request

```text
{
  "request_time": "string",
  "request_token": "string",
  "site_name": "string",
  "proxy_path": "string",
  "proxy_pass": "string",
  "proxy_host": "string",
  "proxy_type": "string",
  "remark": "string"
}
```

## Code samples

### cURL（填写面板地址与签名）

```curl
curl --request POST \
  --url "https://your-panel.example.com:8888/mod/proxy/com/add_proxy/stype" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request_time=<Unix时间戳>" \
  --data-urlencode "request_token=<按 API 概览生成的签名>" \
  --data-urlencode "site_name=<site_name>" \
  --data-urlencode "proxy_path=<proxy_path>" \
  --data-urlencode "proxy_pass=<proxy_pass>" \
  --data-urlencode "action=add_proxy"
```

## Responses

### default

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

#### Example

```json
{
  "status": true,
  "msg": "添加成功！"
}
```

- `opPostModProxyComAddProxyStype.response.default.status` (boolean, optional) — 操作结果
- `opPostModProxyComAddProxyStype.response.default.msg` (string, optional) — 提示信息


## add_proxy

为已有站点添加一条新的反向代理规则（location 块）。

- **路由**：`POST /mod/proxy/com/add_proxy/stype`
- **action**：`add_proxy`

## 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|----------|------|------|------|
| site_name | 是 | string | 站点名称 |
| proxy_path | 是 | string | 代理路径，如 `/api` |
| proxy_pass | 是 | string | 代理目标 URL |
| proxy_host | 否 | string | 代理 Host 头，默认 `$http_host` |
| proxy_type | 否 | string | 代理类型，`http`（默认）或 `unix` |
| remark | 否 | string | 备注 |

> **注意**：同一个 `proxy_path` 不能重复添加。若已存在 basic_auth 且路径冲突，需先删除 basic_auth 再添加。


## 输出参数
| 参数名称 | 类型 | 描述 |
|----------|------|------|
| status | bool | 操作结果 |
| msg | string | 提示信息 |


## 示例

### 请求
```bash
curl -X POST "http://192.168.168.213:8888/mod/proxy/com/add_proxy/stype" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "site_name=example.com&proxy_path=/api&proxy_pass=http://127.0.0.1:3001&request_time=...&request_token=..."
```

### 响应
```json
{
  "status": true,
  "msg": "添加成功！"
}
```