[pve-devel] [PATCH pve-manager v3 2/2] api: add replication config read return schema

Nicolas Frey n.frey at proxmox.com
Thu Oct 2 14:47:28 CEST 2025


The return props now include programmatically added properties guest,
jobnum, and digest (the latter only being returned in read endpoint)
in addition to the create schema.

Signed-off-by: Nicolas Frey <n.frey at proxmox.com>
---
 PVE/API2/ReplicationConfig.pm | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/PVE/API2/ReplicationConfig.pm b/PVE/API2/ReplicationConfig.pm
index 307ebe69..d62caa2a 100644
--- a/PVE/API2/ReplicationConfig.pm
+++ b/PVE/API2/ReplicationConfig.pm
@@ -17,6 +17,18 @@ use PVE::API2::Replication;
 
 use base qw(PVE::RESTHandler);
 
+my $replication_api_return_props = {
+    PVE::ReplicationConfig->createSchema()->{properties}->%*,
+    guest => {
+        type => 'integer',
+        description => 'Guest ID.',
+    },
+    jobnum => {
+        type => 'integer',
+        description => 'Unique, sequential ID assigned to each job.',
+    },
+};
+
 __PACKAGE__->register_method({
     name => 'index',
     path => '',
@@ -35,7 +47,7 @@ __PACKAGE__->register_method({
         type => 'array',
         items => {
             type => "object",
-            properties => {},
+            properties => $replication_api_return_props,
         },
         links => [{ rel => 'child', href => "{id}" }],
     },
@@ -75,7 +87,13 @@ __PACKAGE__->register_method({
             id => get_standard_option('pve-replication-id'),
         },
     },
-    returns => { type => 'object' },
+    returns => {
+        type => "object",
+        properties => {
+            $replication_api_return_props->%*,
+            digest => get_standard_option('pve-config-digest'),
+        },
+    },
     code => sub {
         my ($param) = @_;
 
-- 
2.47.3




More information about the pve-devel mailing list