H1Cloud VLESS · API Docs

Проверить, что API отвечает, и получить список методов. Токен не нужен. То же самое отдаёт GET /.

Состояние сервера: имя ноды, порты WS/Reality/subscription, клиенты, peers и federation. Алиасы: /system, /dashboard.

Список всех клиентов. Алиас: /users.

{
  "ok": true,
  "clients": [
    {
      "name": "test",
      "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "expires_at": 1760000000,
      "left_days": 30,
      "link": "vless://..."
    }
  ]
}

Данные одного клиента по имени. Алиас: GET /info?name=NAME.

Создать клиента. traffic_limit_gb и device_limit опциональны. Алиас: POST /clients.

{
  "name": "test",
  "days": 30,
  "traffic_limit_gb": 100,
  "device_limit": 3
}

Продлить клиента (days прибавляется к текущей дате окончания) и/или изменить лимиты. Алиас: PATCH /clients/NAME.

{
  "name": "test",
  "days": 15,
  "traffic_limit_gb": 50,
  "device_limit": 2
}

Переименовать клиента.

{
  "name": "test",
  "new_name": "newtest"
}

Забанить клиента без удаления: он остаётся в базе, но пропадает из конфига Xray, key.txt и подписок. Алиас: POST /ban {"name":"test"}.

{
  "reason": "chargeback"
}

Разбанить клиента и вернуть его в конфиги/подписки. Алиас: POST /unban {"name":"test"}.

Удалить клиента по имени. Алиас: POST /delete {"name":"test"}.

Все клиенты с готовыми VLESS-ссылками. На сервере обновляется key.txt. Текстовая версия: GET /key.txt.

Последние записи из logs.txt (1–1000, по умолчанию 100).

Текущее имя ноды.

Переименовать ноду. Новое имя попадёт в теги VLESS-ссылок.

{
  "node_name": "Germany"
}

Список peers общей подписки.

Добавить или обновить remote-ноду для общей подписки.

{
  "name": "de",
  "url": "https://DE_IP:SUB_PORT/sub/{uuid}/local"
}

Удалить remote-ноду из общей подписки.

Авто-регистрация ноды (используется командой vpn join): мастер сохраняет ноду, добавляет peer и возвращает upstream API token. Авторизуется по join_token, не по API-токену.

Registry подключённых нод + peers.

Проверить health subscription-серверов всех peers.

Текущий upstream federation-конфиг.

Сохранить upstream к мастер API. Основной процесс будет подтягивать пользователей с мастера. Отключение: DELETE /federation.

{
  "api_url": "https://MASTER_IP:API_PORT/api",
  "token": "MASTER_API_TOKEN"
}

Список созданных бэкапов.

Создать zip-бэкап конфигурации (пользователи, токены, peers, TLS, Reality).

Информация о счётчиках трафика (Xray Stats). Алиас: /stats. Live-значения — через vpn stats в консоли.

Настроить XHTTP-CDN ссылки удалённо (аналог vpn cdn xhttp ...). Алиасы: /server/xhttp-cdn, /server/relay, /config/....

Встроенная веб-панель, которую отдаёт сам API: https://IP:API_PORT/panel. Клиенты, продления, ссылки, peers и federation из браузера.

Задаёт имя локации в тегах ссылок. Вместо lol123-ws клиент увидит, например, Germany WS и Germany Reality.

vpn node Germany

Авто-подключение новой локации одной командой: нода сохраняет upstream, мастер добавляет её в peers.

vpn join https://MASTER_IP:API_PORT/api JOIN_TOKEN Germany

Добавляет remote-ноду в subscription-агрегатор вручную. Главный /sub/UUID вернёт локальные ссылки плюс ссылки всех peers.

vpn peer add de https://IP:PORT/sub/{uuid}/local

Возвращает только ссылки этой ноды. Используется peers, чтобы не было рекурсивного сбора подписок.

Подключает ноду к мастер API. Нода периодически забирает /clients, синхронизирует users.json и перезапускает Xray при изменениях.

vpn federation upstream https://MASTER:PORT/api API_TOKEN