3x-ui/README.md

2.9 KiB

3X-UI

安装 & 更新

bash <(curl -Ls https://raw.githubusercontent.com/jiulingyun/3x-ui/tree/dev/install.sh)

安装指定版本

要安装所需的版本,请将该版本添加到安装命令的末尾。例如: v2.2.1:

bash <(curl -Ls https://raw.githubusercontent.com/jiulingyun/3x-ui/tree/dev/install.sh) v2.2.1

API 路由

点击查看 API 路由详情

使用

  • /login with POST user data: {username: '', password: ''} for login
  • /panel/api/inbounds base for following actions:
Method Path Action
GET "/list" Get all inbounds
GET "/get/:id" Get inbound with inbound.id
GET "/getClientTraffics/:email" Get Client Traffics with email
GET "/createbackup" Telegram bot sends backup to admins
POST "/add" Add inbound
POST "/del/:id" Delete Inbound
POST "/update/:id" Update Inbound
POST "/clientIps/:email" Client Ip address
POST "/clearClientIps/:email" Clear Client Ip address
POST "/addClient" Add Client to inbound
POST "/:id/delClient/:clientId" Delete Client by clientId*
POST "/updateClient/:clientId" Update Client by clientId*
POST "/:id/resetClientTraffic/:email" Reset Client's Traffic
POST "/resetAllTraffics" Reset traffics of all inbounds
POST "/resetAllClientTraffics/:id" Reset traffics of all clients in an inbound
POST "/delDepletedClients/:id" Delete inbound depleted clients (-1: all)
POST "/onlines" Get Online users ( list of emails )

*- 字段“clientId”应由:

  • client.id 适用于 VMESS 和 VLESS

  • client.password 对于 TROJAN

  • client.email 用于 Shadowsocks

  • API Documentation

  • Run In Postman