- fix mixed docs

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

View file

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

View file

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