Update api.py - call out API key usage specifically

You can find docs/issues filed about this, but it's very unclear until you do so that the API Key in the Uptime Kuma web UI is not usable in any way for API calls other than prometheus.
This commit is contained in:
Nathan Neulinger 2023-10-29 15:58:57 -05:00 committed by GitHub
parent 22ca1813ff
commit 27722deffa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2995,6 +2995,9 @@ class UptimeKumaApi(object):
If username and password is not provided, auto login is performed if disableAuth is enabled. If username and password is not provided, auto login is performed if disableAuth is enabled.
Note that the API Key configured in the Uptime Kuma UI is only for authentication for integration with Prometheus. It
cannot be used for authentication to this API.
:param str, optional username: Username. Must be None if disableAuth is enabled., defaults to None :param str, optional username: Username. Must be None if disableAuth is enabled., defaults to None
:param str, optional password: Password. Must be None if disableAuth is enabled., defaults to None :param str, optional password: Password. Must be None if disableAuth is enabled., defaults to None
:param str, optional token: 2FA Token. Required if 2FA is enabled., defaults to "" :param str, optional token: 2FA Token. Required if 2FA is enabled., defaults to ""