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

Updated API Key docs to match new UI 

Updated the API Key docs to match the UI changes made in 11fa690e09

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
Matthew Nickson 2023-02-26 18:19:31 +00:00 committed by GitHub
parent e97fd64eb8
commit 28158ca06b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
APIKeys.md

@ -5,10 +5,8 @@ Prometheus metrics endpoint.
## Adding an API key ## Adding an API key
Management of API keys is done through the API Key management page, Management of API keys is done through the API Keys page in settings
accessible from the drop down menu, just below the maintenance link. This This page will show you all of your API keys, including expired keys.
page will show you all of your API keys, including expired keys. The
green button in the top left can be used to add a new key.
You can set the name of the key, as well as it's expiry date, or You can set the name of the key, as well as it's expiry date, or
optionally set the key to never expire. When you click generate, you optionally set the key to never expire. When you click generate, you
@ -26,7 +24,7 @@ authentication for endpoints will be permanently disabled.
## Disabling keys ## Disabling keys
It is possible to temporarily disable keys. This can be done through the It is possible to temporarily disable keys. This can be done through the
management page. This will prevent the key from being used for settings page. This will prevent the key from being used for
authentication until it is enabled again. authentication until it is enabled again.
## Expired keys ## Expired keys
@ -34,7 +32,7 @@ authentication until it is enabled again.
If a key has expired, it will not be automatically deleted. This is to If a key has expired, it will not be automatically deleted. This is to
aid in debugging systems that suddenly stop working. You can delete an aid in debugging systems that suddenly stop working. You can delete an
expired key, or any key for that matter, by simply hitting the red expired key, or any key for that matter, by simply hitting the red
delete button from the management page. delete button from the settings page.
## Authenticating using an API key ## Authenticating using an API key