Crate unifi_rs

Source
Expand description

UniFi Network API client library

This library provides a Rust interface to the UniFi Network API, allowing you to monitor and manage UniFi deployments.

§Authentication

The client requires an API key for authentication. You can obtain an API key through the UniFi UI:

  1. Open your Site in UniFi Site Manager at unifi.ui.com
  2. Navigate to Control Plane -> Admins & Users
  3. Select your Admin
  4. Click Create API Key
  5. Add a name for your API Key
  6. Copy and securely store the key

§Example

use unifi_rs::{client::{UnifiClient, UnifiClientBuilder}};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = UnifiClientBuilder::new("https://192.168.1.1/proxy/network/integrations")
        .api_key("your-api-key")
        .verify_ssl(false)
        .build()?;

    let sites = client.list_sites(None, None).await?;
    println!("Sites: {:#?}", sites);
    Ok(())
}

Re-exports§

pub use client::*;
pub use errors::*;
pub use models::*;

Modules§

client
errors
models