创建隧道

POST

https://api.locyanfrp.cn/v2/proxy

OAuth 权限节点: Proxy.Record.Create

XTCP STCP 隧道需要提供 secret_key
HTTP HTTPS 隧道需要提供 domain
XTCP STCP HTTP HTTPS 隧道无需提供 remote_port

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/x-www-form-urlencoded

user_id

number

用户 ID

必需

name

string

隧道

必需

local_ip

string

本地服务 IP

必需

type

string

服务协议

必需

local_port

integer

本地服务端口

必需

remote_port

integer

远端服务端口

可选

node_id

number

节点 ID

必需

use_encryption

boolean

是否启用加密

必需

use_compression

boolean

是否启用压缩

必需

secret_key

string

隧道访问密钥

可选

domain

string

域名

可选

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.locyanfrp.cn/v2/proxy' \
--data-urlencode 'user_id=' \
--data-urlencode 'name=' \
--data-urlencode 'local_ip=' \
--data-urlencode 'type=' \
--data-urlencode 'local_port=' \
--data-urlencode 'remote_port=' \
--data-urlencode 'node_id=' \
--data-urlencode 'use_encryption=' \
--data-urlencode 'use_compression=' \
--data-urlencode 'secret_key=' \
--data-urlencode 'domain='

返回响应

🟢200成功

application/json

Body

message

string

返回消息

必需

status

integer

状态

必需

默认值:

200

data

object

必需

proxy_name

string

必需

proxy_id

number

必需

示例

{
  "data": {
    "proxy_id": 0,
    "proxy_name": "{proxy_name}"
  },
  "message": "OK",
  "status": 200
}

修改于 2025-02-15 16:48:26

获取用户访问密钥

删除隧道