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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file uptime_kuma_monitor-1.0.0.tar.gz.

File metadata

  • Download URL: uptime_kuma_monitor-1.0.0.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

File hashes

Hashes for uptime_kuma_monitor-1.0.0.tar.gz
Algorithm Hash digest
SHA256 695a2a879328594615dde827defcc708da3efa34661cd8a2275915094d41247e
MD5 b7f51eb5085ca383d0e89814b8240574
BLAKE2b-256 d4962b01d213c1d0524bf685d048ac8c02af0b847ac9970c2e2ffd2d1ea209f1

See more details on using hashes here.

File details

Details for the file uptime_kuma_monitor-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: uptime_kuma_monitor-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

File hashes

Hashes for uptime_kuma_monitor-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9803bcf8931978230a23cd23f9b67140e7559a88cdf619d353ecf057f24d7015
MD5 8f0cbbdf5fa7f0ddab855a51218a3508
BLAKE2b-256 28f8c14d9026224ec9ef032244799c999f129112c36b9b7b5ddbebfce2df3346

See more details on using hashes here.

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