mirrors/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-19 00:21:54 +03:00
Code Issues Projects Releases Packages Wiki Activity

Clarify the current use of API-keys (#51)

Nelson Chan 2023-08-23 16:34:09 +08:00 committed by GitHub
parent d4de1be936
commit f8621237ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
API-Keys.md

@ -1,7 +1,10 @@
(Version >= 1.21.0) (Version >= 1.21.0)
API keys can be used to access secured HTTP APIs, including the API keys can be enabled to manage access to the Prometheus metrics endpoint.
Prometheus metrics endpoint.
By default, HTTP basic authentication is used to secure access to the Prometheus
metrics endpoint. As soon as you add your first API key, the use of basic
authentication for the endpoint will be permanently disabled.
## Adding an API key ## Adding an API key
@ -16,10 +19,6 @@ be used to access the web interface but you should treat API keys like
you treat your passwords as they can still be used to access potentially you treat your passwords as they can still be used to access potentially
sensitive data. sensitive data.
Note: whilst basic authentication will continue to work after you
update, you will be unable to use basic authentication as soon as you
add your first API key. After you have added your first API key, basic
authentication for endpoints will be permanently disabled.
## Disabling keys ## Disabling keys