docs.rs failed to build nautobot-0.4.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: nautobot-0.3.1

nautobot

ergonomic rust client for the nautobot rest api.

this crate provides a high-level, typed interface for interacting with nautobot, built on top of generated openapi bindings.

install

add this to your Cargo.toml:

[dependencies]
nautobot = "0.3"
tokio = { version = "1.0", features = ["full"] }

optional tracing instrumentation:

[dependencies]
nautobot = { version = "0.3", features = ["tracing"] }

usage

basic example

use nautobot::{Client, ClientConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // initialize the client
    let config = ClientConfig::new("https://nautobot.example.com", "your-api-token");
    let client = Client::new(config)?;

    // list devices from dcim
    let devices = client.dcim().devices().list(None).await?;
    println!("found {} devices", devices.count);

    // iterate through results
    for device in devices.results {
        println!("device: {}", device.name.unwrap_or_default());
    }

    Ok(())
}

ergonomic helpers

the client includes helper methods for common operations that go beyond basic crud:

// ipam: find available ips in a prefix
let available_ips = client.ipam().prefix_available_ips("prefix-uuid", None).await?;

// dcim: trace a cable path from an interface
let trace = client.dcim().interface_trace("interface-uuid").await?;

// extras: run a job
use nautobot::extras::JobInputRequest;
let response = client.extras().job_run("job-uuid", &JobInputRequest::new()).await?;

features