[pdm-devel] [PATCH datacenter-manager 01/11] server: api: return list of pve/pbs remotes

Dominik Csapak d.csapak at proxmox.com
Fri Sep 26 09:20:21 CEST 2025


for the paths /{pve,pbs}/remotes/

This api call is announced as a subdirectory, but had no api call
assigned.

Introduce a new basic api type for this.

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 lib/pdm-api-types/src/remotes.rs | 13 +++++++++++++
 server/src/api/pbs/mod.rs        | 30 ++++++++++++++++++++++++++++--
 server/src/api/pve/mod.rs        | 30 ++++++++++++++++++++++++++++--
 3 files changed, 69 insertions(+), 4 deletions(-)

diff --git a/lib/pdm-api-types/src/remotes.rs b/lib/pdm-api-types/src/remotes.rs
index 7e67eec8..63189438 100644
--- a/lib/pdm-api-types/src/remotes.rs
+++ b/lib/pdm-api-types/src/remotes.rs
@@ -189,3 +189,16 @@ pub enum TlsProbeOutcome {
     /// The certificate is untrusted with the given hostname/fingerprint
     UntrustedCertificate(proxmox_acme_api::CertificateInfo),
 }
+
+#[api(
+    properties: {
+        "remote": { schema: REMOTE_ID_SCHEMA },
+    },
+)]
+/// The information required to connect to a remote instance.
+#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
+#[serde(rename_all = "kebab-case")]
+pub struct RemoteListEntry {
+    /// An id for this entry.
+    pub remote: String,
+}
diff --git a/server/src/api/pbs/mod.rs b/server/src/api/pbs/mod.rs
index 2e203cac..4473c6c8 100644
--- a/server/src/api/pbs/mod.rs
+++ b/server/src/api/pbs/mod.rs
@@ -6,7 +6,9 @@ use proxmox_schema::api;
 use proxmox_schema::property_string::PropertyString;
 use proxmox_sortable_macro::sortable;
 
-use pdm_api_types::remotes::{NodeUrl, Remote, RemoteType, TlsProbeOutcome, REMOTE_ID_SCHEMA};
+use pdm_api_types::remotes::{
+    NodeUrl, Remote, RemoteListEntry, RemoteType, TlsProbeOutcome, REMOTE_ID_SCHEMA,
+};
 use pdm_api_types::{Authid, HOST_OPTIONAL_PORT_FORMAT, PRIV_RESOURCE_AUDIT, PRIV_SYS_MODIFY};
 
 use crate::{
@@ -27,7 +29,9 @@ const SUBDIRS: SubdirMap = &sorted!([
     ("probe-tls", &Router::new().post(&API_METHOD_PROBE_TLS)),
 ]);
 
-const REMOTES_ROUTER: Router = Router::new().match_all("remote", &MAIN_ROUTER);
+const REMOTES_ROUTER: Router = Router::new()
+    .get(&API_METHOD_LIST_REMOTES)
+    .match_all("remote", &MAIN_ROUTER);
 
 pub const MAIN_ROUTER: Router = Router::new()
     .get(&list_subdirs_api_method!(REMOTE_SUBDIRS))
@@ -56,6 +60,28 @@ const DATASTORE_ITEM_SUBDIRS: SubdirMap = &sorted!([
     ),
 ]);
 
+#[api(
+    returns: {
+        type: Array,
+        description: "List of PBS remotes",
+        items: {
+            type: pdm_api_types::remotes::RemoteListEntry,
+        },
+    },
+)]
+/// Return the list of PBS remotes
+fn list_remotes() -> Result<Vec<RemoteListEntry>, Error> {
+    let (remotes, _) = pdm_config::remotes::config()?;
+    let remotes = remotes
+        .into_iter()
+        .filter_map(|(remote, Remote { ty, .. })| match ty {
+            RemoteType::Pbs => Some(RemoteListEntry { remote }),
+            RemoteType::Pve => None,
+        })
+        .collect();
+    Ok(remotes)
+}
+
 #[api(
     input: {
         properties: {
diff --git a/server/src/api/pve/mod.rs b/server/src/api/pve/mod.rs
index edafdded..0de82323 100644
--- a/server/src/api/pve/mod.rs
+++ b/server/src/api/pve/mod.rs
@@ -13,7 +13,9 @@ use proxmox_schema::property_string::PropertyString;
 use proxmox_section_config::typed::SectionConfigData;
 use proxmox_sortable_macro::sortable;
 
-use pdm_api_types::remotes::{NodeUrl, Remote, RemoteType, TlsProbeOutcome, REMOTE_ID_SCHEMA};
+use pdm_api_types::remotes::{
+    NodeUrl, Remote, RemoteListEntry, RemoteType, TlsProbeOutcome, REMOTE_ID_SCHEMA,
+};
 use pdm_api_types::resource::PveResource;
 use pdm_api_types::{
     Authid, RemoteUpid, HOST_OPTIONAL_PORT_FORMAT, PRIV_RESOURCE_AUDIT, PRIV_RESOURCE_DELETE,
@@ -54,7 +56,9 @@ const SUBDIRS: SubdirMap = &sorted!([
     )
 ]);
 
-pub const REMOTES_ROUTER: Router = Router::new().match_all("remote", &MAIN_ROUTER);
+pub const REMOTES_ROUTER: Router = Router::new()
+    .get(&API_METHOD_LIST_REMOTES)
+    .match_all("remote", &MAIN_ROUTER);
 
 const MAIN_ROUTER: Router = Router::new()
     .get(&list_subdirs_api_method!(REMOTE_SUBDIRS))
@@ -111,6 +115,28 @@ fn connect_to_remote(
     connect(get_remote(config, id)?)
 }
 
+#[api(
+    returns: {
+        type: Array,
+        description: "List of PVE remotes",
+        items: {
+            type: RemoteListEntry,
+        },
+    },
+)]
+/// Return the list of PVE remotes
+fn list_remotes() -> Result<Vec<RemoteListEntry>, Error> {
+    let (remotes, _) = pdm_config::remotes::config()?;
+    let remotes = remotes
+        .into_iter()
+        .filter_map(|(remote, Remote { ty, .. })| match ty {
+            RemoteType::Pve => Some(RemoteListEntry { remote }),
+            RemoteType::Pbs => None,
+        })
+        .collect();
+    Ok(remotes)
+}
+
 #[api(
     input: {
         properties: {
-- 
2.47.3





More information about the pdm-devel mailing list