uptime-kuma-api

What it is and what it does

uptime-kuma-api is a Python client library that wraps the Socket.IO API of Uptime Kuma, an open-source uptime monitoring system. It allows you to programmatically interact with an Uptime Kuma instance—creating monitors, managing alerts, querying status—without building raw WebSocket calls yourself. The package has no external runtime dependencies, making it lightweight to install.

The library is designed for automation workflows, particularly Ansible integration, and supports Uptime Kuma versions 1.17.0 through 1.23.2 (with version 1.2.1 of the wrapper). It requires Python 3.7 or later and works with current Python versions. The package is marked Production/Stable but maintenance is dormant, so compatibility with the latest Uptime Kuma releases is uncertain.

Use it for:

• Automate monitor creation and configuration across multiple Uptime Kuma instances via Python scripts or Ansible playbooks.
• Build custom dashboards or reporting tools that pull uptime data directly from Uptime Kuma without manual API calls.
• Manage alert rules and monitor settings programmatically as part of infrastructure-as-code workflows.
• Integrate Uptime Kuma monitoring into larger Python applications or DevOps pipelines.
• Test and validate Uptime Kuma configurations by scripting monitor setup and teardown.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Python wrapper for the Uptime Kuma Socket.IO API that lets you programmatically manage monitors, configure alerts, and query uptime data from an Uptime Kuma server.

Yes, with caution. The package is stable and has no known vulnerabilities, but it has not been updated since 2023-09-26. Install it if you are running Uptime Kuma 1.21.3–1.23.2 and need programmatic API access; verify first that it works with your specific Uptime Kuma version. If you are running a newer Uptime Kuma release, check the repository for any unreleased fixes or consider whether the dormant status poses a risk for your use case.

Install

uptime-kuma-api on PyPI

pip install uptime-kuma-api

uv add uptime-kuma-api

poetry add uptime-kuma-api

Installing uptime-kuma-api

Before you install

High install friction: the package has no runtime dependencies but has not been updated since 2023-09-26. Maintenance is dormant, though the repository remains active with 394 stars and a recent commit in 2024-04-05.

License in practice

MIT license is permissive; you can use, modify, and distribute this package freely with minimal restrictions, making it suitable for both open-source and commercial projects.

Quickstart

pip install uptime-kuma-api

from uptime_kuma_api import UptimeKumaApi, MonitorType

api = UptimeKumaApi('http://127.0.0.1:3001')
api.login('username', 'password')
api.add_monitor(type=MonitorType.HTTP, name="Google", url="https://google.com")
api.disconnect()

Requires Python 3.7 or later. Requires a running Uptime Kuma server instance accessible at the specified URL.

Verify before relying

• Compatibility with Uptime Kuma versions released after 1.23.2 is not documented.
• Whether the package works with current versions of Uptime Kuma given the dormant maintenance status since 2023-09-26.

Package facts

Evidence: uptime_kuma_api-1.2.1.tar.gz

Tags

More Libraries packages