Kuma Client¶

kuma-client is a Rust library for interacting with the Uptime Kuma SocketIO API. It is the foundation that both AutoKuma and Kuma CLI are built on.

Installation¶

Add kuma-client to your Cargo.toml:

[dependencies]
kuma-client = { git = "https://github.com/BigBoot/AutoKuma.git" }

Or find the latest published version on crates.io.

Resources¶

Quick Example¶

use kuma_client::{Client, Config};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::connect(Config {
        url: "http://localhost:3001".parse()?,
        username: Some("admin".into()),
        password: Some("secret".into()),
        ..Default::default()
    })
    .await?;

    let monitors = client.get_monitors().await?;
    for monitor in monitors.values() {
        println!("{}: {}", monitor.common().id().unwrap_or(0), monitor.common().name().as_deref().unwrap_or(""));
    }

    Ok(())
}