Interface UniFiClientConfig

Configuration types for UniFi API Client

interface UniFiClientConfig {
    baseUrl: string;
    username: string;
    password: string;
    site?: string;
    timeout?: number;
    verifySsl?: boolean;
    debug?: boolean;
    headers?: Record<string, string>;
    maxRetries?: number;
    retryDelay?: number;
    autoReauth?: boolean;
}

Properties

baseUrl username password site? timeout? verifySsl? debug? headers? maxRetries? retryDelay? autoReauth?

Properties

baseUrl

baseUrl: string

Base URL of the UniFi Controller (e.g., 'https://unifi.example.com:8443')

username

username: string

Username for authentication

password

password: string

Password for authentication

Optional site

site?: string

Site name/ID (defaults to 'default')

Optional timeout

timeout?: number

Request timeout in milliseconds (defaults to 30000)

Optional verifySsl

verifySsl?: boolean

Whether to verify SSL certificates (defaults to true)

Optional debug

debug?: boolean

Enable debug logging (defaults to false)

Optional headers

headers?: Record<string, string>

Custom headers to include with requests

Optional maxRetries

maxRetries?: number

Maximum number of retry attempts (defaults to 3)

Optional retryDelay

retryDelay?: number

Retry delay in milliseconds (defaults to 1000)

Optional autoReauth

autoReauth?: boolean

Whether to automatically re-authenticate on auth failures (defaults to true)

Settings

Member Visibility

Theme

On This Page

baseUrlusernamepasswordsitetimeoutverifySsldebugheadersmaxRetriesretryDelayautoReauth