Getting Started
Installation
Section titled “Installation”Add to your Cargo.toml:
[dependencies]rusty_falcon = "0.3"tokio = { version = "1", features = ["full"] }Authentication
Section titled “Authentication”Rusty Falcon reads credentials from environment variables via FalconHandle::from_env():
| Variable | Purpose |
|---|---|
FALCON_CLIENT_ID | CrowdStrike API Client ID |
FALCON_CLIENT_SECRET | CrowdStrike API Client Secret |
FALCON_CLOUD | Cloud region (us-1, us-2, eu-1, us-gov-1) |
export FALCON_CLIENT_ID="your-client-id"export FALCON_CLIENT_SECRET="your-client-secret"export FALCON_CLOUD="us-1"Quick Start
Section titled “Quick Start”use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::apis::sensor_download_api;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env() .await .expect("Could not authenticate");
let response = sensor_download_api::get_sensor_installers_ccidby_query( &falcon.cfg ).await.expect("API call failed");
println!("{:?}", response);}Function Names
Section titled “Function Names”Rusty Falcon uses snake_case function names matching the API Operation IDs:
| API Operation | Rust Function |
|---|---|
| CombinedDevicesByFilter | combined_devices_by_filter |
| GetDeviceDetailsV2 | get_device_details_v2 |
| PerformActionV2 | perform_action_v2 |
| QueryDevicesByFilterScroll | query_devices_by_filter_scroll |
Running Examples
Section titled “Running Examples”The repository includes a helper script:
./scripts/run-examples.sh falcon_host_detailsOr run individual examples with cargo:
cargo run --example falcon_host_detailsAvailable Examples
Section titled “Available Examples”simple— Basic authentication and client initializationfalcon_get_cid— Retrieve Customer IDfalcon_host_details— Query host informationfalcon_spotlight_vulnerabilities— Retrieve vulnerabilitiesintel_indicators— Query threat indicatorsfalcon_supported_kernels— List supported Linux kernelsfalcon_custom_ioas— Display custom IOAsfalcon_discover_hosts— Display all tenant hostsfalcon_zta— Zero Trust Assessment data
Resources
Section titled “Resources”Page Updated: v0.7.0