Skip to content
Инфраструктурный API

Устройства

Жизненный цикл устройства на платформе ForestVPN — регистрация, авторизация, heartbeat-сигналы, ротация ключей и роли выходных узлов.

Устройство — это единица, которая на самом деле подключается: телефон, ноутбук, сервер или встраиваемый клиент, принадлежащий ровно одному потребительскому аккаунту и опознаваемый по своему публичному ключу. Семейство /consumer/v1/devices покрывает весь жизненный цикл.

Регистрация и авторизация

  • POST /consumer/v1/devices регистрирует устройство (имя + публичный ключ) на аутентифицированном аккаунте; GET /consumer/v1/devices перечисляет их.
  • Проекты, требующие подтверждения, получают шлюз: GET /consumer/v1/devices/pending перечисляет устройства, ожидающие решения, а POST /consumer/v1/devices/{id}/authorization/approve (или …/reject) закрывает каждое из них. История решений доступна по GET /consumer/v1/devices/{id}/authorization-events.

Активность и сессии

Подключённые устройства отмечаются через POST /consumer/v1/devices/{id}/heartbeat; история их VPN-сессий — по GET /consumer/v1/devices/{id}/sessions, а учёт переданного трафика — по GET /consumer/v1/devices/{id}/usage. Аккаунт (или ваш инструментарий поддержки) может отключить активное устройство через POST /consumer/v1/devices/{id}/force-disconnect.

Гигиена ключей

Ключи устройства меняются без повторной регистрации: POST /consumer/v1/devices/{id}/rotate-key устанавливает новый публичный ключ, а GET /consumer/v1/devices/{id}/key-rotations показывает историю ротаций.

Сетевые роли

Устройство может быть не только клиентом:

  • Выходной узел — операции …/exit-node/enable, approve, disable и revoke управляют жизнью устройства как выхода для других устройств в его сети.
  • Маршруты подсетейPUT /consumer/v1/devices/{id}/advertised-routes анонсирует маршруты, которые устройство может ретранслировать (а DELETE их отзывает).
  • Карта сетиPOST /consumer/v1/devices/{id}/map — это то, как подключённое устройство получает свою текущую карту пиров.

Справочник

Полные формы запросов и ответов для каждой операции выше — в сгенерированном справочнике API в семействе devices плоскости потребителя. Чтобы управлять устройствами из кода приложения, начните с быстрого старта SDK.