LoCyanFrp API
v2
  • v2
  • v3
主站帮助文档
主站帮助文档
v2
  • v2
  • v3
  1. 隧道
  • 首页
  • 数据缓存
  • 鉴权说明
  • OAuth2.0 验证流程
  • 鉴权
    • OAuth
      • 获取访问令牌
  • 用户
    • 获取用户信息
      GET
    • 获取用户访问密钥
      GET
  • 隧道
    • 创建隧道
      POST
    • 删除隧道
      DELETE
    • 获取隧道列表
      GET
    • 获取单个隧道状态
      GET
    • 获取隧道配置文件
      GET
    • 强制下线隧道
      POST
    • 更新隧道信息
      POST
  • 签到
    • 获取签到状态
      GET
    • 签到
      POST
  • 通知
    • 获取公告
      GET
  • 节点
    • 列出全部可用节点
      GET
    • 获取节点统计信息
      GET
    • 获取随机隧道端口
      GET
  • 身份认证
    • 获取认证状态
      GET
  • ICP
    • 工信部
      • 获取验证码图片
      • 提交验证码点位获取人机验证 Sign
    • 添加 ICP 备案记录
      POST
    • 移除 ICP 备案记录
      DELETE
    • 获取已登记 ICP 备案列表
      GET
  • Minecraft
    • 获取 Minecraft 服务器状态
    • 获取 Minecraft 游戏连接信息
    • 创建 Minecraft 联机房间
    • 删除 Minecraft 联机房间
    • 获取用户全部 Minecraft 游戏
  • 软件
    • 获取 Frp 版本列表
  • 连接
  1. 隧道

获取隧道配置文件

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 参数
user_id
number 
用户 ID
必需
proxy_id
number 
隧道 ID
可选
node_id
number 
节点 ID
可选

示例代码

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/v2/proxy/config?user_id=&proxy_id=&node_id='

返回响应

🟢200成功
application/json
Body
message
string 
返回消息
必需
status
integer 
状态
必需
默认值:
200
data
object 
必需
config
string 
配置文件内容
必需
示例
{
    "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
上一页
获取单个隧道状态
下一页
强制下线隧道
Built with