From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 2FEFA6BA0D for ; Tue, 21 Sep 2021 12:11:21 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 2E046C188 for ; Tue, 21 Sep 2021 12:11:21 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 52398C179 for ; Tue, 21 Sep 2021 12:11:20 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 2BE71449E3 for ; Tue, 21 Sep 2021 12:11:20 +0200 (CEST) From: Dominik Csapak To: pbs-devel@lists.proxmox.com Date: Tue, 21 Sep 2021 12:11:18 +0200 Message-Id: <20210921101118.2640200-8-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210921101118.2640200-1-d.csapak@proxmox.com> References: <20210921101118.2640200-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.372 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v4 7/7] docs: proxmox-backup-debug: add info about the 'api' subcommand X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 21 Sep 2021 10:11:21 -0000 and mention PROXMOX_DEBUG_API_CODE and that its dangerous. Signed-off-by: Dominik Csapak --- 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. + -- 2.30.2