TaiwanFRP HTTP API 文件
本頁詳細列出 TaiwanFRP 伺服器所有 HTTP API 的請求格式與回應格式,適用於自動化、第三方整合或開發用途。
1. 使用者註冊/登入/帳號管理
POST /register
{
"username": "string",
"password": "string",
"discordUsername": "string"
}
回應:
{
"success": true,
"message": "註冊成功"
}
{
"success": false,
"message": "錯誤訊息"
}
POST /login
{
"username": "string",
"password": "string"
}
回應:
{
"success": true,
"message": "登入成功"
}
{
"success": false,
"message": "錯誤訊息"
}
POST /logout
無參數
回應:
{
"success": true
}
POST /delete_account
{
"username": "string",
"password": "string"
}
回應:
{
"success": true,
"message": "帳號已刪除"
}
2. 代理/節點/端口/隧道管理
GET /nodes.json
回應:
{
"nodes": [
{
"name": "string",
"ip": "string",
"availablePorts": [7000, 7001],
"frpcIniFolder": "string",
"portFile": "string",
"AuthportFile": "string",
"authendpoint": "string",
"owner": "string"
}
]
}
POST /apply_node
{
"username": "string",
"password": "string",
"nodeName": "string",
"nodeIp": "string",
"nodePorts": [7000, 7001],
"nodeAlias": "string"
}
回應:
{
"success": true,
"message": "申請成功"
}
GET /check_port/:port
回應:
{
"occupied": true,
"username": "string"
}
POST /check_tunnel
{
"username": "string",
"password": "string",
"tunnelName": "string",
"protocol": "tcp|udp",
"nodeName": "string"
}
回應:
{
"status": "online|offline",
"info": {"...": "..."}
}
POST /get_frpc_ini
{
"node": "string"
}
回應:
text/plain
[common]
...
3. 管理員相關
POST /admin_login
{
"verificationCode": "string"
}
回應:
{
"success": true
}
GET /get_users (需管理員驗證)
回應:
{
"user1": {"...": "..."},
"user2": {"...": "..."}
}
POST /edit_account (需管理員驗證)
{
"username": "string",
"newPassword": "string"
}
回應:
text/plain
密碼更新成功
4. 其他
GET /registered_users_count
回應:
{
"count": 123
}
GET /download/:platform
回應:檔案下載
GET /files/:filename
回應:檔案下載