From 28158ca06bd6eb1c641de4f94f2f216faedbc108 Mon Sep 17 00:00:00 2001 From: Matthew Nickson Date: Sun, 26 Feb 2023 18:19:31 +0000 Subject: [PATCH] Updated API Key docs to match new UI Updated the API Key docs to match the UI changes made in 11fa690e0915b9be166b861cf704c76db864e59d Signed-off-by: Matthew Nickson --- APIKeys.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/APIKeys.md b/APIKeys.md index 381b82a..654fe84 100644 --- a/APIKeys.md +++ b/APIKeys.md @@ -5,10 +5,8 @@ Prometheus metrics endpoint. ## Adding an API key -Management of API keys is done through the API Key management page, -accessible from the drop down menu, just below the maintenance link. This -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. +Management of API keys is done through the API Keys page in settings +This page will show you all of your API keys, including expired keys. 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 @@ -26,7 +24,7 @@ authentication for endpoints will be permanently disabled. ## Disabling keys 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. ## 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 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 -delete button from the management page. +delete button from the settings page. ## Authenticating using an API key