LoCyanFrp API
v3
  • v2
  • v3
主站帮助文档
主站帮助文档
v3
  • v2
  • v3
  1. 隧道
  • 首页
  • 鉴权说明
  • 鉴权验证流程
  • 鉴权
    • OAuth
      • 获取刷新令牌
      • 获取访问令牌
  • 用户
    • 获取用户信息
      GET
    • 获取用户访问密钥
      GET
  • 身份认证
    • 获取认证状态
      GET
  • 节点
    • 列出可用节点
      GET
    • 获取节点统计信息
      GET
    • 获取随机隧道端口
      GET
  • 隧道
    • 获取隧道列表
      GET
    • 获取隧道信息
      GET
    • 创建隧道
      PUT
    • 更新隧道信息
      PATCH
    • 批量更新隧道信息
      PATCH
    • 删除隧道
      DELETE
    • 批量删除隧道
      DELETE
    • 获取单个隧道状态
      GET
    • 获取多个隧道状态
      GET
    • 获取隧道配置文件
      GET
    • 强制下线隧道
      DELETE
    • 批量强制下线隧道
      DELETE
  • 域名
    • 获取域名列表
      GET
  • 签到
    • 获取签到状态
    • 签到
  • 游戏
    • Minecraft
      • 获取 Minecraft 服务器状态
      • 获取 Minecraft 游戏连接信息
      • 获取用户全部 Minecraft 游戏
      • 创建 Minecraft 联机房间
      • 删除 Minecraft 联机房间
  • 软件
    • 获取软件列表
    • 获取软件资源列表
    • 获取 Frp 版本列表
  • 站点
    • 获取公告
  1. 隧道

获取隧道配置文件

已测完
GET
https://api.locyanfrp.cn/v3/tunnel/config
OAuth 权限节点: Tunnel.Read.Config
tunnel_id 与 node_id 只能提供其中一个
当提供 tunnel_id 时返回单个隧道配置文件
当提供 node_id 时返回该节点下该用户所有隧道配置文件

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.locyanfrp.cn/v3/tunnel/config?user_id=&tunnel_id=&node_id=&format' \
--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-06-17 08:31:36
上一页
获取多个隧道状态
下一页
强制下线隧道
Built with