From eb37ce767d73b064b0260432e4a3323cf8e8d758 Mon Sep 17 00:00:00 2001 From: Arksine Date: Tue, 16 Feb 2021 11:43:31 -0500 Subject: [PATCH] docs: add documentation for "/server/config" endpoint Signed-off-by: Eric Callahan --- docs/web_api.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/web_api.md b/docs/web_api.md index 95c314c..54b29a1 100644 --- a/docs/web_api.md +++ b/docs/web_api.md @@ -227,6 +227,30 @@ websocket. See the `notify_status_update` notification for details. enabled plugins. This can be used by clients to check if an optional plugin is available. +### Get Server Configuration +- HTTP command:\ + `GET /server/config` + +- Websocket command: + `{jsonrpc: "2.0", method: "server.config", id: }` + +- Returns:\ + An object containing the server's configuration, structured as follows: + +```json +{ + config: { + server: { + ... + }, + authorization: { + ... + }, + ... + } +} +``` + ### Fetch stored temperature data - HTTP command:\ `GET /server/temperature_store`