获取隧道配置文件

GET

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

OAuth 权限节点: Proxy.Config

proxy_id 与 node_id 只能提供其中一个

当提供 proxy_id 时返回单个隧道配置文件
当提供 node_id 时返回该节点下该用户所有隧道配置文件

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Query 参数

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.locyanfrp.cn/v2/proxy/config?user_id=&proxy_id=&node_id=' \
--header 'Authorization: Bearer <token>'

返回响应

🟢200成功

application/json

Body

示例

{
    "data": {
        "config": "[common]\nserver_addr = {server_address}\nserver_port = {server_port}\ntcp_mux = true\nprotocol = tcp\nuser = {frp_token}\ntoken = LoCyanToken\ndns_server = 223.6.6.6\ntls_enable = false\n\n[minec1111]\nprivilege_mode = true\ntype = tcp\nlocal_ip = {local_ip}\nlocal_port = {local_port}\nremote_port = {remote_port}"
    },
    "message": "OK",
    "status": 200
}

修改于 2025-04-23 10:34:30

获取单个隧道状态

强制下线隧道