跳到主要内容

API 使用指南

RelayX 提供 RESTful API 接口，支持通过 API Key 进行身份验证，方便对接自动化工具和第三方系统。

信息

API 功能需要商业授权才能使用。

获取 API Key​

  1. 登录 RelayX 面板
  2. 进入「个人中心」
  3. 在 API Key 区域点击「查看」获取你的 API Key

API 文档​

RelayX 提供了完整的 OpenAPI 文档，部署完成后可以通过以下地址访问：

  • API 文档（Scalar UI）：https://你的域名/docs
  • OpenAPI JSON：https://你的域名/openapi.json

认证方式​

所有 API 请求需要在 HTTP Header 中携带 API Key：

Authorization: Bearer 你的API_KEY

使用示例​

获取用户信息​

curl -X GET https://你的域名/user/info \
  -H "Authorization: Bearer 你的API_KEY"

获取隧道列表​

curl -X GET https://你的域名/tunnel \
  -H "Authorization: Bearer 你的API_KEY"

创建隧道​

curl -X POST https://你的域名/tunnel \
  -H "Authorization: Bearer 你的API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "我的隧道",
    "tunnel_type": "wss",
    "listen_port": 8080,
    "in_node_group_id": 1,
    "out_node_group_id": 2,
    "forward_addresses": [
      {
        "address": "127.0.0.1:3000",
        "weight": 1
      }
    ]
  }'

更新隧道​

curl -X PATCH https://你的域名/tunnel/1 \
  -H "Authorization: Bearer 你的API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "新名称",
    "forward_addresses": [
      {
        "address": "127.0.0.1:8080",
        "weight": 1
      }
    ]
  }'

启用/停用隧道​

curl -X PATCH https://你的域名/tunnel/1/status \
  -H "Authorization: Bearer 你的API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "active"
  }'

删除隧道​

curl -X DELETE https://你的域名/tunnel \
  -H "Authorization: Bearer 你的API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [1, 2, 3]
  }'

获取流量统计​

curl -X GET "https://你的域名/tunnel/traffic/stats?type=day" \
  -H "Authorization: Bearer 你的API_KEY"

主要 API 端点​

路径方法说明
/user/infoGET获取用户信息和当前套餐
/tunnelGET获取隧道列表
/tunnelPOST创建隧道
/tunnel/:idPATCH更新隧道
/tunnel/:id/statusPATCH启用/停用隧道
/tunnelDELETE批量删除隧道
/tunnel/importPOST批量导入隧道
/tunnel/traffic/statsGET流量统计
/tunnel/statsGET隧道状态统计
/node/groupGET获取节点组列表
/node/group/summaryGET节点组概要
/nodeGET获取节点列表
/planGET获取套餐列表
/plan/:id/subscribePOST订阅套餐
/plan/renewPOST续费套餐
提示

完整的 API 接口文档和参数说明请访问 /docs 页面，支持在线调试。

错误码​

HTTP 状态码说明
200请求成功
400请求参数错误
401认证失败（API Key 无效或过期）
403权限不足（需要商业授权或套餐不满足）
404资源不存在
500服务器内部错误