clientapi-pbs 2026.5.24

Generated from apidoc.js. NOT an official Proxmox specification. See https://pbs.proxmox.com/docs/api-viewer/ for the upstream documentation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

/*
 * Proxmox Backup Server API
 *
 * Generated from apidoc.js. NOT an official Proxmox specification. See https://pbs.proxmox.com/docs/api-viewer/ for the upstream documentation.
 *
 * The version of the OpenAPI document: 9.x
 * 
 * Generated by: https://openapi-generator.tech
 */


use reqwest;
use serde::{Deserialize, Serialize, de::Error as _};
use crate::{apis::ResponseContent, models};
use super::{Error, configuration, ContentType};


/// struct for typed errors of method [`backup_get_backup`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum BackupGetBackupError {
    Status400(models::PbsError),
    Status401(models::PbsError),
    Status403(models::PbsError),
    Status404(models::PbsError),
    Status500(models::PbsError),
    Status501(models::PbsError),
    Status503(models::PbsError),
    UnknownValue(serde_json::Value),
}


/// Upgraded to backup protocol ('proxmox-backup-protocol-v1').  Permissions: Requires on /datastore/{store}[/{namespace}] DATASTORE_BACKUP and being the owner of the group
pub async fn backup_get_backup(configuration: &configuration::Configuration, backup_id: &str, backup_time: i64, backup_type: models::PbsBackupTypeEnum, store: &str, benchmark: Option<bool>, debug: Option<bool>, no_cache: Option<bool>, ns: Option<&str>) -> Result<models::BackupGetBackupResponse, Error<BackupGetBackupError>> {
    // add a prefix to parameters to efficiently prevent name collisions
    let p_query_backup_id = backup_id;
    let p_query_backup_time = backup_time;
    let p_query_backup_type = backup_type;
    let p_query_store = store;
    let p_query_benchmark = benchmark;
    let p_query_debug = debug;
    let p_query_no_cache = no_cache;
    let p_query_ns = ns;

    let uri_str = format!("{}/backup", configuration.base_path);
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    req_builder = req_builder.query(&[("backup-id", &p_query_backup_id.to_string())]);
    req_builder = req_builder.query(&[("backup-time", &p_query_backup_time.to_string())]);
    req_builder = req_builder.query(&[("backup-type", &p_query_backup_type.to_string())]);
    if let Some(ref param_value) = p_query_benchmark {
        req_builder = req_builder.query(&[("benchmark", &param_value.to_string())]);
    }
    if let Some(ref param_value) = p_query_debug {
        req_builder = req_builder.query(&[("debug", &param_value.to_string())]);
    }
    if let Some(ref param_value) = p_query_no_cache {
        req_builder = req_builder.query(&[("no-cache", &param_value.to_string())]);
    }
    if let Some(ref param_value) = p_query_ns {
        req_builder = req_builder.query(&[("ns", &param_value.to_string())]);
    }
    req_builder = req_builder.query(&[("store", &p_query_store.to_string())]);
    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(ref apikey) = configuration.api_key {
        let key = apikey.key.clone();
        let value = match apikey.prefix {
            Some(ref prefix) => format!("{} {}", prefix, key),
            None => key,
        };
        req_builder = req_builder.header("Authorization", value);
    };
    if let Some(ref apikey) = configuration.api_key {
        let key = apikey.key.clone();
        let value = match apikey.prefix {
            Some(ref prefix) => format!("{} {}", prefix, key),
            None => key,
        };
        req_builder = req_builder.header("CSRFPreventionToken", value);
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::BackupGetBackupResponse`"))),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::BackupGetBackupResponse`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<BackupGetBackupError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}