Struct PiholeClient 

pub struct PiholeClient {
    pub http: Client,
    pub base_url: String,
    /* private fields */
}

Pi-hole v6 REST API client.

Pi-hole uses session-based authentication: the password is exchanged for a session SID via POST /api/auth, and that SID is sent as a Bearer token on every subsequent request. Because sessions expire (default 1800 s), each public HTTP method obtains a fresh SID so callers don’t need to manage state.

Fields

http: Client

base_url: String

Implementations

impl PiholeClient

pub fn new(base_url: String, password: ApiToken) -> Result<Self>

pub async fn get(&self, path: &str, params: &[(&str, String)]) -> Result<Value>

pub async fn post(&self, path: &str, body: &Value) -> Result<Value>

pub async fn delete(&self, path: &str) -> Result<Value>

pub async fn delete_with_body(&self, path: &str, body: &Value) -> Result<Value>

Trait Implementations

impl AccessListRead for PiholeClient

async fn list_blocked(&self) -> Result<Value>

async fn list_allowed(&self) -> Result<Value>

impl AccessListWrite for PiholeClient

async fn add_blocked<'a>(&'a self, domain: &'a str) -> Result<Value>

async fn delete_blocked<'a>(&'a self, domain: &'a str) -> Result<Value>

async fn add_allowed<'a>(&'a self, domain: &'a str) -> Result<Value>

async fn delete_allowed<'a>(&'a self, domain: &'a str) -> Result<Value>

impl CacheRead for PiholeClient

async fn list_cache<'a>(&'a self, _domain: &'a str) -> Result<Value>

impl CacheWrite for PiholeClient

async fn delete_cache_zone<'a>(&'a self, _domain: &'a str) -> Result<Value>

async fn flush_cache(&self) -> Result<Value>

impl Clone for PiholeClient

fn clone(&self) -> PiholeClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PiholeClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DnsVendor for PiholeClient

fn kind(&self) -> VendorKind

fn capabilities(&self) -> VendorCapabilities

impl LogsRead for PiholeClient

async fn get_logs(&self, _options: LogsOptions) -> Result<Vec<LogLine>>

impl RecordWrite for PiholeClient

async fn add_record<'a>( &'a self, _zone: &'a str, domain: &'a str, _ttl: u32, record: &'a RecordData, ) -> Result<Value>

async fn delete_record<'a>( &'a self, _zone: &'a str, domain: &'a str, type_params: &'a [(&'a str, String)], ) -> Result<Value>

impl SettingsRead for PiholeClient

async fn get_settings(&self) -> Result<Value>

impl StatsRead for PiholeClient

async fn get_stats<'a>(&'a self, stats_type: &'a str) -> Result<Value>

impl ZoneExport for PiholeClient

async fn export_zone_file<'a>(&'a self, _zone: &'a str) -> Result<String>

impl ZoneImport for PiholeClient

async fn import_zone_file<'a>( &'a self, _zone: &'a str, _file_name: String, _file_bytes: Vec<u8>, _overwrite: bool, _overwrite_zone: bool, _overwrite_soa_serial: bool, ) -> Result<Value>

impl ZoneRead for PiholeClient

async fn list_zones<'a>(&'a self, _page: u32, _per_page: u32) -> Result<Value>

async fn list_records<'a>( &'a self, domain: &'a str, zone: Option<&'a str>, _options: ListRecordsOptions, ) -> Result<ListRecordsResponse>

impl ZoneWrite for PiholeClient

async fn create_zone<'a>( &'a self, _zone: &'a str, _zone_type: &'a str, ) -> Result<Value>

async fn delete_zone<'a>(&'a self, _zone: &'a str) -> Result<Value>

async fn enable_zone<'a>(&'a self, _zone: &'a str) -> Result<Value>

async fn disable_zone<'a>(&'a self, _zone: &'a str) -> Result<Value>