4 KiB
API Reference - Rampart Manager
REST API управления. Base URL:
http://MANAGER:8080Авторизация: Bearer JWT (получить через/api/v1/auth/login).
Реализованные маршруты — см. src/bin/rampart-manager.rs. Это полный список: ничего сверх перечисленного здесь API не предоставляет.
Аутентификация
POST /api/v1/auth/login
// Request
{"password": "значение API_PASSWORD"}
// Response 200
{"token": "eyJhbGciOiJIUzI1NiIs..."}
// 401 → неверный пароль; 429 → больше 5 попыток за минуту с одного IP
Все защищённые запросы:
Authorization: Bearer <token>
Токен живёт JWT_EXPIRATION_SECS секунд (дефолт 86400).
Health (публичный)
GET /api/v1/health
{"status": "healthy", "version": "0.3.0-dev"}
Servers
GET /api/v1/servers 🔒
Список серверов из Redis-реестра (rampart:servers:*).
{
"servers": [
{"name": "app-01", "type": "tcp", "ip": "10.0.2.1", "port": 25566, "status": "online"}
]
}
Если Redis недоступен, API возвращает 503 Service Unavailable.
Blacklist
GET /api/v1/blacklist 🔒
{
"items": [
{"target": "1.2.3.4", "type": "ip", "reason": "manual_ban",
"created_at": "2026-10-16T12:00:00+00:00", "expires_at": "2026-10-16T13:00:00+00:00"}
],
"total": 42
}
Источник: Redis set rampart:blacklist и hash rampart:blacklist:metadata.
Метаданные содержат причину, время создания и абсолютный срок истечения; API
скрывает истёкшие записи. Старые set-записи без метаданных получают один
ограниченный срок в пять минут при первом чтении или восстановлении edge.
POST /api/v1/blacklist 🔒
// Request
{"target": "1.2.3.4", "type": "ip", "reason": "manual_ban", "duration_secs": 3600}
// Response 200 — запись и метаданные атомарно сохранены в Redis, а событие
// с duration_secs и expires_at_unix опубликовано в rampart:blacklist:events.
Edge подписывается на Pub/Sub перед загрузкой снимка из Redis. Поэтому события,
пришедшие во время загрузки, будут применены после снимка. При старте и после
переподключения активные Redis-баны восстанавливаются с оставшимся TTL; новые
события используют абсолютный срок и игнорируются, если он уже прошёл. Старый
формат события только с duration_secs продолжает поддерживаться.
DELETE /api/v1/blacklist 🔒
{"target": "1.2.3.4"}
Удаляет только Redis-бан и его метаданные, затем публикует событие unban. Локальные баны детекторов хранятся отдельно и этим запросом не снимаются.
Nodes
GET /api/v1/nodes 🔒
Список зарегистрированных edge-нод из Redis (rampart:nodes:*, heartbeat).
{
"nodes": [
{"id": "edge-eu-1", "role": "edge", "ip": "10.0.100.1",
"status": "online", "last_heartbeat": "..."}
]
}
Не реализовано
Честно, на текущий момент в API нет:
- drain нод через API или CLI;
- webhooks, metrics summary, challenge management;
- регистрации нод через
POST /api/v1/nodes; - rate limiting на сами запросы API (кроме login).
Версия: 2.0 | Август 2026