3x-ui/docs/API.ru.md

143 lines
4.2 KiB
Markdown
Raw Normal View History

2025-02-07 06:13:53 +00:00
# API Documentation
2025-02-11 08:22:21 +00:00
Для выполнения запросов к REST API v2 в каждом запросе необходимо передавать заголовок Authorization с типом Bearer и указанием токена.
```
Authorization: Bearer {token}
```
## Inbounds
2025-02-07 06:13:53 +00:00
### Get All Inbounds
- **Method**: `GET`
- **Endpoint**: `/inbounds/`
2025-02-07 06:13:53 +00:00
- **Description**: Получить список всех inbounds.
2025-02-07 06:13:53 +00:00
### Reset All Client Traffics
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/traffic`
2025-02-07 06:13:53 +00:00
- **Description**: Сбросить трафик всех клиентов.
---
## Inbound
2025-02-07 06:13:53 +00:00
### Add Inbound
- **Method**: `POST`
- **Endpoint**: `/inbounds/`
2025-02-07 06:13:53 +00:00
- **Description**: Добавить новый inbound.
2025-02-07 06:13:53 +00:00
### Get Inbound by ID
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id`
2025-02-07 06:13:53 +00:00
- **Description**: Получить информацию о конкретном inbound по его ID.
2025-02-07 06:13:53 +00:00
### Delete Inbound by ID
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id`
2025-02-07 06:13:53 +00:00
- **Description**: Удалить inbound по его ID.
2025-02-07 06:13:53 +00:00
### Update Inbound by ID
- **Method**: `PUT`
- **Endpoint**: `/inbounds/:id`
2025-02-07 06:13:53 +00:00
- **Description**: Обновить информацию о inbound по его ID.
2025-02-07 06:13:53 +00:00
### Delete Inbound Traffic
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/traffic`
2025-02-07 06:13:53 +00:00
- **Description**: Удалить трафик inbound по его ID.
2025-02-07 06:13:53 +00:00
### Delete Depleted Clients
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/depleted-clients`
2025-02-07 06:13:53 +00:00
- **Description**: Удалить клиентов с исчерпанным трафиком для конкретного inbound.
---
2025-02-07 06:13:53 +00:00
## Inbound Clients
2025-02-07 06:13:53 +00:00
### Get Inbound Clients
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/`
2025-02-07 06:13:53 +00:00
- **Description**: Получить список клиентов для конкретного inbound.
---
2025-02-07 06:13:53 +00:00
## Inbound Client
2025-02-07 06:13:53 +00:00
### Add Inbound Client
- **Method**: `POST`
- **Endpoint**: `/inbounds/:id/clients`
2025-02-07 06:13:53 +00:00
- **Description**: Добавить нового клиента к inbound.
2025-02-07 06:13:53 +00:00
### Get Client by ID
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
2025-02-07 06:13:53 +00:00
- **Description**: Получить информацию о клиенте по его ID.
2025-02-07 06:13:53 +00:00
### Update Inbound Client
- **Method**: `PUT`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
2025-02-07 06:13:53 +00:00
- **Description**: Обновить информацию о клиенте по его ID.
2025-02-07 06:13:53 +00:00
### Delete Inbound Client
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/:clientId`
2025-02-07 06:13:53 +00:00
- **Description**: Удалить клиента по его ID.
2025-02-07 06:13:53 +00:00
### Get Client Traffics by ID
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/:clientId/traffic`
2025-02-07 06:13:53 +00:00
- **Description**: Получить статистику трафика клиента по его ID.
---
2025-02-07 06:13:53 +00:00
## Inbound Client by Email
2025-02-07 06:13:53 +00:00
### Get Client by Email
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email`
2025-02-07 06:13:53 +00:00
- **Description**: Получить информацию о клиенте по его email.
2025-02-07 06:13:53 +00:00
### Get Client IPs
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email/ips`
2025-02-07 06:13:53 +00:00
- **Description**: Получить список IP-адресов клиента по его email.
2025-02-07 06:13:53 +00:00
### Clear Client IPs
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/email/:email/ips`
2025-02-07 06:13:53 +00:00
- **Description**: Очистить список IP-адресов клиента по его email.
2025-02-07 06:13:53 +00:00
### Get Client Traffics by Email
- **Method**: `GET`
- **Endpoint**: `/inbounds/:id/clients/email/:email/traffic`
2025-02-07 06:13:53 +00:00
- **Description**: Получить статистику трафика клиента по его email.
2025-02-07 06:13:53 +00:00
### Reset Client Traffic by Email
- **Method**: `DELETE`
- **Endpoint**: `/inbounds/:id/clients/email/:email/traffic`
2025-02-07 06:13:53 +00:00
- **Description**: Сбросить трафик клиента по его email.
---
2025-02-07 06:13:53 +00:00
## Other
2025-02-07 06:13:53 +00:00
### Create Backup
- **Method**: `GET`
- **Endpoint**: `/inbounds/create-backup`
2025-02-07 06:13:53 +00:00
- **Description**: Создать резервную копию данных.
2025-02-07 06:13:53 +00:00
### Get Online Clients
- **Method**: `GET`
- **Endpoint**: `/inbounds/online`
2025-02-07 06:13:53 +00:00
- **Description**: Получить список онлайн-клиентов.
---
2025-02-07 06:13:53 +00:00
## Server
2025-02-07 06:13:53 +00:00
### Get Server Status
- **Method**: `GET`
- **Endpoint**: `/server/status`
2025-02-07 06:13:53 +00:00
- **Description**: Получить статус сервера.