uptime-kuma-api/docs/api.rst

.. _api:


Main Interface
--------------

.. module:: uptime_kuma_api

.. autoclass:: UptimeKumaApi
    :inherited-members:


Enums
-----

.. autoclass:: AuthMethod
    :members:

.. autoclass:: MonitorType
    :members:

.. autoclass:: NotificationType
    :members:

.. autoclass:: ProxyProtocol
    :members:

.. autoclass:: IncidentStyle
    :members:

.. autoclass:: DockerType
    :members:

.. autoclass:: MaintenanceStrategy
    :members:


Exceptions
----------

.. autoexception:: UptimeKumaException

.. autoexception:: Timeout
docs: add docstrings and sphinx, readthedocs configuration 2022-12-16 21:39:18 +01:00			`.. _api:`


			`Main Interface`
			`--------------`

			`.. module:: uptime_kuma_api`

			`.. autoclass:: UptimeKumaApi`
			`:inherited-members:`


			`Enums`
			`-----`

			`.. autoclass:: AuthMethod`
			`:members:`

			`.. autoclass:: MonitorType`
			`:members:`

			`.. autoclass:: NotificationType`
			`:members:`

			`.. autoclass:: ProxyProtocol`
			`:members:`

			`.. autoclass:: IncidentStyle`
			`:members:`

			`.. autoclass:: DockerType`
			`:members:`

feat: add support for uptime kuma 1.19.2 2022-12-29 00:22:53 +01:00			`.. autoclass:: MaintenanceStrategy`
			`:members:`

docs: add docstrings and sphinx, readthedocs configuration 2022-12-16 21:39:18 +01:00
			`Exceptions`
			`----------`

			`.. autoexception:: UptimeKumaException`
feat: implement timeouts for all methods (#34) BREAKING CHANGE: 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. 2023-05-19 13:50:39 +02:00
			`.. autoexception:: Timeout`