xui-rs 2.0.1

A modern, typed async Rust SDK for the 3x-ui panel API
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

use reqwest::Method;

use super::OpenApiDocument;
use crate::{Client, Result, client::AuthenticationScope};

/// Panel-wide operations that do not belong to a domain controller.
#[derive(Clone, Copy, Debug)]
pub struct PanelApi<'client> {
    client: &'client Client,
}

impl<'client> PanelApi<'client> {
    pub(crate) const fn new(client: &'client Client) -> Self {
        Self { client }
    }

    /// Downloads the runtime `OpenAPI` document used by the panel's API page.
    ///
    /// Unlike normal panel endpoints, this route returns the document directly
    /// rather than wrapping it in a 3x-ui response envelope. Its `servers`
    /// entry reflects the connected panel's configured base path.
    ///
    /// # Errors
    ///
    /// Returns an error when retrieval or JSON decoding fails.
    pub async fn openapi(self) -> Result<OpenApiDocument> {
        self.client
            .execute_response::<OpenApiDocument, ()>(
                Method::GET,
                "panel/api/openapi.json",
                None,
                AuthenticationScope::PanelApi,
            )
            .await
    }

    /// Sends a fresh database backup to configured Telegram administrators.
    ///
    /// The v3.8.5 handler returns an empty HTTP 200 response and does not report
    /// per-recipient delivery results.
    ///
    /// # Errors
    ///
    /// Returns an error when authentication, CSRF handling, transport, or the
    /// HTTP status fails.
    pub async fn backup_to_telegram(self) -> Result<()> {
        self.client
            .execute_empty::<()>(
                Method::POST,
                "panel/api/backuptotgbot",
                None,
                AuthenticationScope::PanelApi,
            )
            .await
    }
}