Skip to main content

Python wrapper around Uptime Kuma /metrics endpoint

Project description

Uptime Kuma Monitor

Python wrapper around UptimeKuma /metrics endpoint

Installation

pip install uptime_kuma_monitor

QuickStart

>>> from uptime_kuma_monitor import UptimeKumaMonitor
>>> utkm = UptimeKumaMonitor("https://your_uptime-kuma_url", "uptime-kuma_username", "uptime-kuma_password")
>>> utkm.data
{
    'UptimeKuma': {'monitor_cert_days_remaining': 55.0, 'monitor_cert_is_valid': 1.0, 'monitor_response_time': 141.0, 'monitor_status': 1.0},
    'AdGuard Home': {'monitor_cert_days_remaining': 55.0, 'monitor_cert_is_valid': 1.0, 'monitor_response_time': 22.0, 'monitor_status': 1.0},
    'Bitwarden': {'monitor_cert_days_remaining': 55.0, 'monitor_cert_is_valid': 1.0, 'monitor_response_time': 17.0, 'monitor_status': 1.0},
    'Home Assistant': {'monitor_cert_days_remaining': 55.0, 'monitor_cert_is_valid': 1.0, 'monitor_response_time': 114.0, 'monitor_status': 1.0},
    'Gitea': {'monitor_cert_days_remaining': 55.0, 'monitor_cert_is_valid': 1.0, 'monitor_response_time': 2331.0, 'monitor_status': 1.0},
    'NginxProxyManager': {'monitor_cert_days_remaining': 55.0, 'monitor_cert_is_valid': 1.0, 'monitor_response_time': 18.0, 'monitor_status': 1.0},
    ...
}
>>> utkm.data['UptimeKuma']['monitor_response_time']
13.0
>>> utkm.data['UptimeKuma']['monitor_status']
1.0

Notes:

  • The user must have access to the Uptime Kuma /metrics endpoint

Change Log

  • v1.0.0 : Initial Release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uptime_kuma_monitor-1.0.0.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

uptime_kuma_monitor-1.0.0-py3-none-any.whl (3.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page