ChmlFrpApi

修改隧道

POST

/update_tunnel

这里除了tunnelid、token参数是用于验证权限及隧道的之外，其他的均用于更新隧道。如tunnelname传递"tunnel1"，则隧道名更新为"tunnel1"

请求参数

Body 参数application/json

tunnelid

integer

隧道ID

必需

token

string

用户Token

必需

tunnelname

string

隧道名

必需

node

string

节点名

必需

localip

string

本地IP

可选

可选，不传递则默认为127.0.0.1

porttype

string

端口类型

必需

仅允许tcp、udp、http、https，可为大写，也可大小写混用

localport

integer

本地端口

必需

remoteport

integer

外网端口

可选

如果porttype参数为tcp、udp，则这个字段为必须，同时禁止传递banddomain

banddomain

string

绑定域名

可选

如果porttype参数为http、https，则这个字段为必须，同时禁止传递remoteport

encryption

boolean

数据加密

可选

传递true或false，可为string和boolean。不传递则默认为false

compression

boolean

数据压缩

可选

传递true或false，可为string和boolean。不传递则默认为false

extraparams

string

额外参数

可选

不传递则默认为空

示例

{
  "tunnelid": 0,
  "token": "string",
  "tunnelname": "string",
  "node": "string",
  "localip": "string",
  "porttype": "string",
  "localport": 0,
  "remoteport": 0,
  "banddomain": "string",
  "encryption": true,
  "compression": true,
  "extraparams": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://cf-v2.uapis.cn/update_tunnel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tunnelid": 0,
    "token": "string",
    "tunnelname": "string",
    "node": "string",
    "localip": "string",
    "porttype": "string",
    "localport": 0,
    "remoteport": 0,
    "banddomain": "string",
    "encryption": true,
    "compression": true,
    "extraparams": "string"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

state

string

状态

必需

msg

string

必需

这里的信息仅为示例，请以实际为准

示例

{
  "code": 0,
  "state": "string",
  "msg": "string"
}

删除隧道

获取配置文件