Struct UnifiClient 

pub struct UnifiClient { /* private fields */ }

UniFi DNS-policy client.

site holds the user-configured value — typically the human-readable site name (e.g. "Default"), but a UUID is also accepted. The first DNS call resolves that label to the controller’s actual site UUID via GET /v1/sites and caches it for the lifetime of the client.

Implementations

impl UnifiClient

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

Build a new client. Uses a 30-second timeout to match the rest of the vendor clients in this crate.

pub fn base_url(&self) -> &str

pub fn site(&self) -> &str

The configured site identifier as supplied via config or env vars. This is what the user typed and may be either a name or a UUID.

pub async fn resolve_site_id(&self) -> Result<&str>

Resolve the configured site (name or UUID) to the canonical UniFi site UUID.

On first call this performs GET /v1/sites and matches the configured value against each site’s id, name, and internalReference (case-insensitively). The resolved UUID is cached for the lifetime of the client so subsequent DNS calls don’t pay the site-list cost.

If no site matches the configured value, returns Error::Api whose message lists every valid human-readable site name so the user can fix their config without leaving the CLI.

pub async fn list_sites_page( &self, offset: u32, limit: u32, ) -> Result<UnifiSitePage>

GET /v1/sites — single page of sites accessible to this API key.

pub async fn list_all_sites(&self) -> Result<Vec<UnifiSite>>

Fetch every site by paginating until exhausted.

Same termination logic as list_all_dns_policies: stops on empty page, known totalCount, or short page; capped at 1000 pages.

pub async fn list_dns_policies_page( &self, offset: u32, limit: u32, filter: Option<&str>, ) -> Result<UnifiDnsPolicyPage>

GET /sites/{siteId}/dns/policies — single page.

Caller controls pagination through offset and limit. limit is clamped to the documented maximum of 200.

pub async fn list_all_dns_policies( &self, filter: Option<&str>, ) -> Result<Vec<UnifiDnsPolicy>>

Fetch every DNS policy by paginating until exhausted.

Termination: stops when an empty page is returned, or when totalCount (if present) has been reached. Hard cap of 1000 pages guards against pathological controller responses.

pub async fn create_dns_policy(&self, body: &Value) -> Result<UnifiDnsPolicy>

POST /sites/{siteId}/dns/policies

pub async fn get_dns_policy(&self, policy_id: &str) -> Result<UnifiDnsPolicy>

GET /sites/{siteId}/dns/policies/{dnsPolicyId}

pub async fn update_dns_policy( &self, policy_id: &str, body: &Value, ) -> Result<UnifiDnsPolicy>

PUT /sites/{siteId}/dns/policies/{dnsPolicyId}

UniFi requires the full create/update payload — partial updates are not supported. Caller is responsible for sending all fields.

pub async fn delete_dns_policy(&self, policy_id: &str) -> Result<()>

DELETE /sites/{siteId}/dns/policies/{dnsPolicyId}

Trait Implementations

impl AccessListRead for UnifiClient

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

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

impl AccessListWrite for UnifiClient

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 UnifiClient

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

impl CacheWrite for UnifiClient

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

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

impl Clone for UnifiClient

fn clone(&self) -> UnifiClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnifiClient

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

Formats the value using the given formatter.

impl DnsVendor for UnifiClient

fn kind(&self) -> VendorKind

fn capabilities(&self) -> VendorCapabilities

impl LogsRead for UnifiClient

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

impl RecordWrite for UnifiClient

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 UnifiClient

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

Returns the list of UniFi sites accessible to this API key, plus the configured site label and whether it resolves to a known site. Use this to discover the human-readable site name to put in org_id.

impl StatsRead for UnifiClient

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

impl ZoneExport for UnifiClient

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

impl ZoneImport for UnifiClient

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 UnifiClient

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

UniFi exposes no zone abstraction — there is nothing to list. Returning unsupported lets the trait surface that clearly rather than faking a synthetic zone list.

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

impl ZoneWrite for UnifiClient

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>