Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/MHSanaei/3x-ui.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHo3ein <ho3ein.sanaei@gmail.com>2023-04-11 22:39:29 +0300
committerGitHub <noreply@github.com>2023-04-11 22:39:29 +0300
commitde8ba292534e1ade2d7665a1e91734d7070ae085 (patch)
tree7e324c14f4abb83ecfa717cc0ca4c2b8f6f311b1 /README.md
parentab4b10f619c9832e725d3e6ec9c99e9e74b24589 (diff)
Update README.md - API routes
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index cef3f567..8c3bb5c8 100644
--- a/README.md
+++ b/README.md
@@ -100,6 +100,28 @@ Reference syntax:
- Check depleted users
- Receive backup by request and in periodic reports
+
+## API routes
+
+- `/login` with `PUSH` user data: `{username: '', password: ''}` for login
+- `/xui/API/inbounds` base for following actions:
+
+| Method | Path | Action |
+| ------------- | ------------- | ------------- |
+| GET | "/list" | Get all inbounds |
+| GET | "/get/:id" | Get inbound with inbound.id |
+| 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 | "/delClient/:email" | Delete Client |
+| POST | "/updateClient/:index" | Update Client |
+| 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 |
+
# A Special Thanks To
- [alireza0](https://github.com/alireza0/)
- [FranzKafkaYu](https://github.com/FranzKafkaYu)