Проекты/UptimeKumaAPI

Информация о проекте

UptimeKumaAPI - библиотека с открытым исходным кодом для разработчиков на платформе .NET(языки программирования C#, VB.NET, F#), позволяющая работать с API скрипта для мониторинга работы сервисов и прочих систем — Uptime Kuma. В данный момент присутствуют функции, доступные обычному пользователю: получение данных, конфигурации и подобного. API для работы с административными функциями будет добавлено в следующей версии.

Актуальная версия: 1.0

Скачивание

Скачать библиотеку можно с официального сайта Unkov.

Документация

Начало использования библиотеки

1) Если библиотека скачана в виде .dll файла:

- Добавить .dll файл в "Ссылки" к проекту в обозревателе решений Visual Studio.

Если библиотека скачана с NuGet, встроенного в Visual Studio, вышеуказанного делать не нужно

2) Необходимо инициализировать библиотеку с помощью ``using``. Например, using UptimeKumaAPI;

3) Теперь нужно создать объект главного класса библиотеки. Например, var hub = new KumaAPIHub("https://uptime.unkov.su/");

Функции

string GetStatusPageConfig(string statusPage = "default") - ``Получить конфигурацию страницы статуса``

string GetStatusPageIncident(string statusPage = "default") - ``Получить инцидент со страницы статуса``

string GetStatusPagePublicGroupList(string statusPage = "default") - ``Получить публичный групповой лист страницы статуса``

string GetMonitorsHearbeatList(string statusPage = "default") - ``Получить список пинга мониторов со страницы статуса``

string GetMonitorsUptimeList(string statusPage = "default") - ``Получить аптайм мониторов со страницы статуса``

bool Push(string code, string status = "up", string msg = "OK", string ping = "") - ``Сделать пуш в монитор страницы статуса``

string GetEntryPage() - ``Получить входную страницу``

string GetStatusBadge(int monitor) - ``Получить значок статуса монитора``

string GetUptimeBadge(int monitor, int hours) - ``Получить значок аптайма монитора``

string GetPingBadge(int monitor, int hours) - ``Получить значок пинга монитора``