Alex-Devera/3x-ui
1
0
Fork 0
mirror of https://github.com/MHSanaei/3x-ui.git synced 2025-04-20 05:52:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

- fix mixed docs

Browse source
This commit is contained in:
Аlexander Kiselev 2025-02-07 09:13:53 +03:00
parent 14137af453
commit e1569e2cad
2 changed files with 144 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

144
docs/API.es.md
View file

@ -1,137 +1,137 @@
# API Documentation
# Documentación de la API
## Inbounds
### Get All Inbounds
- **Method**: `GET`
### Obtener todos los Inbounds
- **Método**: `GET`
- **Endpoint**: `/inbounds/`
- **Description**: Получить список всех inbounds.
- **Descripción**: Obtener una lista de todos los inbounds.
### Reset All Client Traffics
- **Method**: `DELETE`
### Restablecer todo el tráfico de clientes
- **Método**: `DELETE`
- **Endpoint**: `/inbounds/traffic`
- **Description**: Сбросить трафик всех клиентов.
- **Descripción**: Restablecer el tráfico de todos los clientes.
---
## Inbound
### Add Inbound
- **Method**: `POST`
### Agregar Inbound
- **Método**: `POST`
- **Endpoint**: `/inbounds/`
- **Description**: Добавить новый inbound.
- **Descripción**: Agregar un nuevo inbound.
### Get Inbound by ID
- **Method**: `GET`
### Obtener Inbound por ID
- **Método**: `GET`
- **Endpoint**: `/inbounds/:id`
- **Description**: Получить информацию о конкретном inbound по его ID.
- **Descripción**: Obtener información sobre un inbound específico por su ID.
### Delete Inbound by ID
- **Method**: `DELETE`
### Eliminar Inbound por ID
- **Método**: `DELETE`
- **Endpoint**: `/inbounds/:id`
- **Description**: Удалить inbound по его ID.
- **Descripción**: Eliminar un inbound por su ID.
### Update Inbound by ID
- **Method**: `PUT`
### Actualizar Inbound por ID
- **Método**: `PUT`
- **Endpoint**: `/inbounds/:id`
- **Description**: Обновить информацию о inbound по его ID.
- **Descripción**: Actualizar la información de un inbound por su ID.
### Delete Inbound Traffic
- **Method**: `DELETE`
### Eliminar tráfico de Inbound
- **Método**: `DELETE`
- **Endpoint**: `/inbounds/:id/traffic`
- **Description**: Удалить трафик inbound по его ID.
- **Descripción**: Eliminar el tráfico de un inbound por su ID.
### Delete Depleted Clients
- **Method**: `DELETE`
### Eliminar clientes con tráfico agotado
- **Método**: `DELETE`
- **Endpoint**: `/inbounds/:id/depleted-clients`
- **Description**: Удалить клиентов с исчерпанным трафиком для конкретного inbound.
- **Descripción**: Eliminar clientes con tráfico agotado para un inbound específico.
---
## Inbound Clients
## Clientes de Inbound
### Get Inbound Clients
- **Method**: `GET`
### Obtener clientes de Inbound
- **Método**: `GET`
- **Endpoint**: `/inbounds/:id/clients/`
- **Description**: Получить список клиентов для конкретного inbound.
- **Descripción**: Obtener una lista de clientes para un inbound específico.
---
## Inbound Client
## Cliente de Inbound
### Add Inbound Client
- **Method**: `POST`
### Agregar cliente de Inbound
- **Método**: `POST`
- **Endpoint**: `/inbounds/:id/clients`
- **Description**: Добавить нового клиента к inbound.
- **Descripción**: Agregar un nuevo cliente a un inbound.
### Get Client by ID
- **Method**: `GET`
### Obtener cliente por ID
- **Método**: `GET`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
- **Description**: Получить информацию о клиенте по его ID.
- **Descripción**: Obtener información sobre un cliente por su ID.
### Update Inbound Client
- **Method**: `PUT`
### Actualizar cliente de Inbound
- **Método**: `PUT`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
- **Description**: Обновить информацию о клиенте по его ID.
- **Descripción**: Actualizar la información del cliente por su ID.
### Delete Inbound Client
- **Method**: `DELETE`
### Eliminar cliente de Inbound
- **Método**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
- **Description**: Удалить клиента по его ID.
- **Descripción**: Eliminar un cliente por su ID.
### Get Client Traffics by ID
- **Method**: `GET`
### Obtener tráfico del cliente por ID
- **Método**: `GET`
- **Endpoint**: `/inbounds/:id/clients/:clientId/traffic`
- **Description**: Получить статистику трафика клиента по его ID.
- **Descripción**: Obtener estadísticas de tráfico para un cliente por su ID.
---
## Inbound Client by Email
## Cliente de Inbound por correo electrónico
### Get Client by Email
- **Method**: `GET`
### Obtener cliente por correo electrónico
- **Método**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email`
- **Description**: Получить информацию о клиенте по его email.
- **Descripción**: Obtener información del cliente por correo electrónico.
### Get Client IPs
- **Method**: `GET`
### Obtener IPs del cliente
- **Método**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email/ips`
- **Description**: Получить список IP-адресов клиента по его email.
- **Descripción**: Obtener una lista de direcciones IP del cliente por correo electrónico.
### Clear Client IPs
- **Method**: `DELETE`
### Limpiar IPs del cliente
- **Método**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/email/:email/ips`
- **Description**: Очистить список IP-адресов клиента по его email.
- **Descripción**: Limpiar la lista de direcciones IP del cliente por correo electrónico.
### Get Client Traffics by Email
- **Method**: `GET`
### Obtener tráfico del cliente por correo electrónico
- **Método**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email/traffic`
- **Description**: Получить статистику трафика клиента по его email.
- **Descripción**: Obtener estadísticas de tráfico para un cliente por correo electrónico.
### Reset Client Traffic by Email
- **Method**: `DELETE`
### Restablecer tráfico del cliente por correo electrónico
- **Método**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/email/:email/traffic`
- **Description**: Сбросить трафик клиента по его email.
- **Descripción**: Restablecer el tráfico de un cliente por correo electrónico.
---
## Other
## Otros
### Create Backup
- **Method**: `GET`
### Crear copia de seguridad
- **Método**: `GET`
- **Endpoint**: `/inbounds/create-backup`
- **Description**: Создать резервную копию данных.
- **Descripción**: Crear una copia de seguridad de los datos.
### Get Online Clients
- **Method**: `GET`
### Obtener clientes en línea
- **Método**: `GET`
- **Endpoint**: `/inbounds/online`
- **Description**: Получить список онлайн-клиентов.
- **Descripción**: Obtener una lista de clientes en línea.
---
## Server
## Servidor
### Get Server Status
- **Method**: `GET`
### Obtener estado del servidor
- **Método**: `GET`
- **Endpoint**: `/server/status`
- **Description**: Получить статус сервера.
- **Descripción**: Obtener el estado del servidor.

144
docs/API.ru.md
View file

@ -1,137 +1,137 @@
# Documentación de la API
# API Documentation
## Inbounds
### Obtener todos los Inbounds
- **Método**: `GET`
### Get All Inbounds
- **Method**: `GET`
- **Endpoint**: `/inbounds/`
- **Descripción**: Obtener una lista de todos los inbounds.
- **Description**: Получить список всех inbounds.
### Restablecer todo el tráfico de clientes
- **Método**: `DELETE`
### Reset All Client Traffics
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/traffic`
- **Descripción**: Restablecer el tráfico de todos los clientes.
- **Description**: Сбросить трафик всех клиентов.
---
## Inbound
### Agregar Inbound
- **Método**: `POST`
### Add Inbound
- **Method**: `POST`
- **Endpoint**: `/inbounds/`
- **Descripción**: Agregar un nuevo inbound.
- **Description**: Добавить новый inbound.
### Obtener Inbound por ID
- **Método**: `GET`
### Get Inbound by ID
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id`
- **Descripción**: Obtener información sobre un inbound específico por su ID.
- **Description**: Получить информацию о конкретном inbound по его ID.
### Eliminar Inbound por ID
- **Método**: `DELETE`
### Delete Inbound by ID
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id`
- **Descripción**: Eliminar un inbound por su ID.
- **Description**: Удалить inbound по его ID.
### Actualizar Inbound por ID
- **Método**: `PUT`
### Update Inbound by ID
- **Method**: `PUT`
- **Endpoint**: `/inbounds/:id`
- **Descripción**: Actualizar la información de un inbound por su ID.
- **Description**: Обновить информацию о inbound по его ID.
### Eliminar tráfico de Inbound
- **Método**: `DELETE`
### Delete Inbound Traffic
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/traffic`
- **Descripción**: Eliminar el tráfico de un inbound por su ID.
- **Description**: Удалить трафик inbound по его ID.
### Eliminar clientes con tráfico agotado
- **Método**: `DELETE`
### Delete Depleted Clients
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/depleted-clients`
- **Descripción**: Eliminar clientes con tráfico agotado para un inbound específico.
- **Description**: Удалить клиентов с исчерпанным трафиком для конкретного inbound.
---
## Clientes de Inbound
## Inbound Clients
### Obtener clientes de Inbound
- **Método**: `GET`
### Get Inbound Clients
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/`
- **Descripción**: Obtener una lista de clientes para un inbound específico.
- **Description**: Получить список клиентов для конкретного inbound.
---
## Cliente de Inbound
## Inbound Client
### Agregar cliente de Inbound
- **Método**: `POST`
### Add Inbound Client
- **Method**: `POST`
- **Endpoint**: `/inbounds/:id/clients`
- **Descripción**: Agregar un nuevo cliente a un inbound.
- **Description**: Добавить нового клиента к inbound.
### Obtener cliente por ID
- **Método**: `GET`
### Get Client by ID
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
- **Descripción**: Obtener información sobre un cliente por su ID.
- **Description**: Получить информацию о клиенте по его ID.
### Actualizar cliente de Inbound
- **Método**: `PUT`
### Update Inbound Client
- **Method**: `PUT`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
- **Descripción**: Actualizar la información del cliente por su ID.
- **Description**: Обновить информацию о клиенте по его ID.
### Eliminar cliente de Inbound
- **Método**: `DELETE`
### Delete Inbound Client
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
- **Descripción**: Eliminar un cliente por su ID.
- **Description**: Удалить клиента по его ID.
### Obtener tráfico del cliente por ID
- **Método**: `GET`
### Get Client Traffics by ID
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/:clientId/traffic`
- **Descripción**: Obtener estadísticas de tráfico para un cliente por su ID.
- **Description**: Получить статистику трафика клиента по его ID.
---
## Cliente de Inbound por correo electrónico
## Inbound Client by Email
### Obtener cliente por correo electrónico
- **Método**: `GET`
### Get Client by Email
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email`
- **Descripción**: Obtener información del cliente por correo electrónico.
- **Description**: Получить информацию о клиенте по его email.
### Obtener IPs del cliente
- **Método**: `GET`
### Get Client IPs
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email/ips`
- **Descripción**: Obtener una lista de direcciones IP del cliente por correo electrónico.
- **Description**: Получить список IP-адресов клиента по его email.
### Limpiar IPs del cliente
- **Método**: `DELETE`
### Clear Client IPs
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/email/:email/ips`
- **Descripción**: Limpiar la lista de direcciones IP del cliente por correo electrónico.
- **Description**: Очистить список IP-адресов клиента по его email.
### Obtener tráfico del cliente por correo electrónico
- **Método**: `GET`
### Get Client Traffics by Email
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email/traffic`
- **Descripción**: Obtener estadísticas de tráfico para un cliente por correo electrónico.
- **Description**: Получить статистику трафика клиента по его email.
### Restablecer tráfico del cliente por correo electrónico
- **Método**: `DELETE`
### Reset Client Traffic by Email
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/email/:email/traffic`
- **Descripción**: Restablecer el tráfico de un cliente por correo electrónico.
- **Description**: Сбросить трафик клиента по его email.
---
## Otros
## Other
### Crear copia de seguridad
- **Método**: `GET`
### Create Backup
- **Method**: `GET`
- **Endpoint**: `/inbounds/create-backup`
- **Descripción**: Crear una copia de seguridad de los datos.
- **Description**: Создать резервную копию данных.
### Obtener clientes en línea
- **Método**: `GET`
### Get Online Clients
- **Method**: `GET`
- **Endpoint**: `/inbounds/online`
- **Descripción**: Obtener una lista de clientes en línea.
- **Description**: Получить список онлайн-клиентов.
---
## Servidor
## Server
### Obtener estado del servidor
- **Método**: `GET`
### Get Server Status
- **Method**: `GET`
- **Endpoint**: `/server/status`
- **Descripción**: Obtener el estado del servidor.
- **Description**: Получить статус сервера.