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

`POST /mod/proxy/com/get_proxy_list/stype`

获取指定站点在 JSON 配置文件中的所有反向代理规则。

## Request body

_Required._

- `opPostModProxyComGetProxyListStype.request_time` (string, required) — Unix 时间戳；与接口密钥一起生成 request_token。
- `opPostModProxyComGetProxyListStype.request_token` (string, required) — 按 API 概览中的双重 MD5 签名算法生成。
- `opPostModProxyComGetProxyListStype.site_name` (string, required) — 站点名称

## Example request

```text
{
  "request_time": "string",
  "request_token": "string",
  "site_name": "string"
}
```

## Code samples

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

```curl
curl --request POST \
  --url "https://your-panel.example.com:8888/mod/proxy/com/get_proxy_list/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 "action=get_proxy_list"
```

## Responses

### default

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

#### Example

```json
{
  "status": true,
  "data": [
    {
      "proxy_type": "http",
      "proxy_path": "/",
      "proxy_pass": "http://127.0.0.1:8080",
      "proxy_host": "$http_host",
      "websocket": {
        "websocket_status": true
      },
      "gzip": {
        "gzip_status": false
      },
      "remark": ""
    }
  ]
}
```

- `opPostModProxyComGetProxyListStype.response.default.data` (array<unknown>, optional) — 代理规则列表，每项包含 proxy_type, proxy_path, proxy_pass, proxy_host, websocket, gzip, proxy_cache, sub_filter, ip_limit, basic_auth, custom_conf, remark, timeout 等配置


## get_proxy_list

获取指定站点在 JSON 配置文件中的所有反向代理规则。

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

## 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|----------|------|------|------|
| site_name | 是 | string | 站点名称 |

## 输出参数
| 参数名称 | 类型 | 描述 |
|----------|------|------|
| data | list | 代理规则列表，每项包含 proxy_type, proxy_path, proxy_pass, proxy_host, websocket, gzip, proxy_cache, sub_filter, ip_limit, basic_auth, custom_conf, remark, timeout 等配置 |

## 示例

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

### 响应
```json
{
  "status": true,
  "data": [
    {
      "proxy_type": "http",
      "proxy_path": "/",
      "proxy_pass": "http://127.0.0.1:8080",
      "proxy_host": "$http_host",
      "websocket": {"websocket_status": true},
      "gzip": {"gzip_status": false},
      "remark": ""
    }
  ]
}
```

