From f7885eb2633b131cb57ee4dd668e407c1783cb59 Mon Sep 17 00:00:00 2001 From: Dominik Csapak Date: Tue, 21 Sep 2021 12:11:18 +0200 Subject: [PATCH] docs: proxmox-backup-debug: add info about the 'api' subcommand and mention PROXMOX_DEBUG_API_CODE and that its dangerous. Signed-off-by: Dominik Csapak Signed-off-by: Thomas Lamprecht --- docs/proxmox-backup-debug/description.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/proxmox-backup-debug/description.rst b/docs/proxmox-backup-debug/description.rst index 0b263e8c..2e5f35fe 100644 --- a/docs/proxmox-backup-debug/description.rst +++ b/docs/proxmox-backup-debug/description.rst @@ -1,3 +1,14 @@ Implements debugging functionality to inspect Proxmox Backup datastore files, verify the integrity of chunks. +Also contains an 'api' subcommand where arbitrary api paths can be called +(get/create/set/delete) as well as display their parameters (usage) and +their child-links (ls). + +By default, it connects to the proxmox-backup-proxy on localhost via https, +but by setting the environment variable `PROXMOX_DEBUG_API_CODE` to `1` the +tool directly calls the corresponding code. + +.. WARNING:: Using `PROXMOX_DEBUG_API_CODE` can be dangerous and is only intended + for debugging purposes. It is not intended for use on a production system. +