uptime-kuma-api-v2

What it is and what it does

uptime-kuma-api-v2 is a Python wrapper around the Uptime Kuma Socket.IO API, enabling programmatic interaction with an Uptime Kuma monitoring server. It abstracts the WebSocket communication layer, allowing you to create monitors, manage notifications, retrieve status data, and automate monitoring tasks from Python code. The package depends on python-socketio for WebSocket connectivity and packaging for version handling.

Typical usage involves instantiating an API client with a server URL, authenticating with credentials, then calling methods to manage monitors and retrieve uptime data. The package supports context managers for automatic resource cleanup and is actively maintained with support for Python 3.7 through 3.11. It carries an MIT license, making it suitable for both open-source and commercial use.

Use it for:

• Automate creation and configuration of HTTP/TCP monitors on an Uptime Kuma instance from a deployment script.
• Build a custom dashboard or reporting tool that pulls uptime statistics from Uptime Kuma via the Python API.
• Integrate Uptime Kuma monitoring into a larger infrastructure-as-code or DevOps automation workflow.
• Programmatically manage alert thresholds and notification settings across multiple monitors.
• Sync monitor definitions from an external configuration source into Uptime Kuma using this client.

Worth the install?

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

Provides a Python client for the Uptime Kuma Socket.IO API, allowing programmatic control of monitors, notifications, and status checks on an Uptime Kuma server.

Yes. The package has low install friction, active maintenance, no known vulnerabilities, and a permissive MIT license. It directly solves the problem of programmatic Uptime Kuma control from Python. Install it if you need to automate Uptime Kuma operations or integrate monitoring into a larger application.

Install

uptime-kuma-api-v2 on PyPI

pip install uptime-kuma-api-v2

uv add uptime-kuma-api-v2

poetry add uptime-kuma-api-v2

Installing uptime-kuma-api-v2

Before you install

Low friction installation with only two runtime dependencies (python-socketio and packaging). The package is actively maintained with a recent release and no known vulnerabilities.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart

pip install uptime-kuma-api-v2

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

Requires Python 3.7 or later and a running Uptime Kuma server instance to connect to.

Verify before relying

• Exact list of supported Uptime Kuma versions beyond 2.0.0-beta.2 for version 1.0.3
• Full API method coverage and whether all Uptime Kuma features are exposed

Package facts

Evidence: uptime_kuma_api_v2-1.0.3-py3-none-any.whl

Tags

More Libraries packages