API Reference

Программный интерфейс для интеграции Larmeo с внешними системами мониторинга и автоматизации.

Обзор API

API Larmeo предоставляет доступ к настройкам платформы, информации об агентах и результатам сетевых измерений.

  • HTTPS-интерфейс
  • Формат данных JSON
  • Токенная аутентификация
  • Версионирование методов API

Аутентификация

Для выполнения запросов используется токен доступа.

Authorization: Bearer YOUR_API_TOKEN

Методы API

GET /api/v1/status

Возвращает текущее состояние платформы.

{
  "status": "online",
  "agents": 12,
  "version": "1.5.0"
}

GET /api/v1/agents

Возвращает список зарегистрированных агентов.

{
  "agents": [
    {
      "id": "agent-001",
      "status": "online",
      "last_seen": "2026-08-07T10:00:00Z"
    }
  ]
}

GET /api/v1/metrics

Возвращает данные сетевых измерений.

{
  "latency_ms": 24,
  "packet_loss": 0.01,
  "jitter_ms": 2
}

Коды ответов

200 Запрос успешно выполнен
401 Требуется авторизация
403 Доступ запрещён
404 Ресурс не найден
500 Внутренняя ошибка сервера