uptime-kuma-api/CHANGELOG.md
2023-08-29 18:41:23 +02:00

3.9 KiB

Changelog

Release 1.2.0

Features

  • add support for uptime kuma 1.23.0 and 1.23.1

Bugfixes

  • remove name from maintenance monitors and status pages
  • rstip url globally
  • convert sendUrl from bool to int
  • validate accepted status codes types

Release 1.1.0

Features

  • add support for uptime kuma 1.22.0 and 1.22.1

Release 1.0.1

Bugfixes

  • fix ValueError if monitor authMethod is None

Release 1.0.0

Features

  • add ssl_verify parameter
  • add wait_events parameter
  • implement context manager for UptimeKumaApi class
  • drop Python 3.6 support
  • implement get_monitor_status helper method
  • implement timeouts for all methods (timeout parameter)
  • add support for uptime kuma 1.21.3
  • drop support for Uptime Kuma versions < 1.21.3
  • check for required notification arguments
  • raise exception when deleting an element that does not exist
  • replace raw return values with enum values

Bugfixes

  • adjust monitor status type to allow all used values
  • fix memory leak

BREAKING CHANGES

  • Python 3.7+ required
  • maintenance parameter timezone renamed to timezoneOption
  • Removed the wait_timeout parameter. Use the new timeout parameter instead. The timeout parameter specifies how many seconds the client should wait for the connection, an expected event or a server response.
  • changed return values of methods get_heartbeats, get_important_heartbeats, avg_ping, uptime, cert_info
  • Uptime Kuma versions < 1.21.3 are not supported in uptime-kuma-api 1.0.0+
  • Removed the get_heartbeat method. This method was never intended to retrieve information. Use get_heartbeats or get_important_heartbeats instead.
  • Types of return values changed to enum values:
    • monitor: type (str -> MonitorType), status (bool -> MonitorStatus), authMethod (str -> AuthMethod)
    • notification: type (str -> NotificationType)
    • docker host: dockerType (str -> DockerType)
    • status page: style (str -> IncidentStyle)
    • maintenance: strategy (str -> MaintenanceStrategy)
    • proxy: protocol (str -> ProxyProtocol)

Release 0.13.0

Feature

  • add support for uptime kuma 1.21.2
  • implement custom socketio headers

Bugfix

  • do not wait for events that have already arrived

Release 0.12.0

Feature

  • add support for uptime kuma 1.21.1

Release 0.11.0

Feature

  • add support for uptime kuma 1.21.0

Release 0.10.0

Feature

  • add support for uptime kuma 1.20.0

Release 0.9.0

Feature

  • add support for uptime kuma 1.19.5

Release 0.8.0

Feature

  • add support for uptime kuma 1.19.3

Release 0.7.1

Bugfix

  • remove unsupported type hints on old python versions

Release 0.7.0

Feature

  • add support for uptime kuma 1.19.2

Bugfix

  • skip condition check for None values

Release 0.6.0

Feature

  • add parameter wait_timeout to adjust connection timeout

Release 0.5.2

Bugfix

  • add type to notification provider options

Release 0.5.1

Bugfix

  • remove required notification provider args check

Release 0.5.0

Feature

  • support for uptime kuma 1.18.3

Release 0.4.0

Feature

  • support for uptime kuma 1.18.1 / 1.18.2

Bugfix

  • update event list data after changes

Release 0.3.0

Feature

  • support autoLogin for enabled disableAuth

Bugfix

  • set_settings password is only required if disableAuth is enabled
  • increase event wait time to receive the slow statusPageList event

Release 0.2.2

Bugfix

  • remove tags from monitor input
  • convert monitor notificationIDList only once

Release 0.2.1

Bugfix

  • generate pushToken on push monitor save
  • convert monitor notificationIDList return value

Release 0.2.0

Feature

  • support for uptime kuma 1.18.0

Bugfix

  • convert values on monitor edit

Release 0.1.1

Bugfix

  • implement 2FA login
  • allow to add monitors to status pages
  • do not block certain methods

Release 0.1.0

  • initial release