@ctrl/sabnzbd
    Preparing search index...

    Interface SabFullStatus

    Shared header fields SABnzbd includes in both mode=queue and mode=fullstatus.

    https://github.com/sabnzbd/sabnzbd/blob/develop/sabnzbd/api.py (build_header)

    interface SabFullStatus {
        active_lang: string;
        active_socks5_proxy?: string | null;
        apikey: string;
        cache_art: string;
        cache_buster: string;
        cache_size: string;
        color_scheme: string;
        completedir: string;
        completedirspeed: number;
        configfn: string;
        confighelpuri: string;
        cpumodel?: string;
        darwin?: boolean;
        delayed_assembler: number;
        diskspace1: string;
        diskspace1_norm: string;
        diskspace2: string;
        diskspace2_norm: string;
        diskspacetotal1: string;
        diskspacetotal2: string;
        dnslookup?: boolean;
        downloaddir: string;
        downloaddirspeed: number;
        finishaction: string | null;
        folders: string[];
        have_quota: boolean;
        have_warnings: string;
        internetbandwidth: number;
        ipv6?: string | null;
        left_quota: string;
        loadavg: string;
        localipv4?: string;
        logfile: string;
        loglevel: string;
        macos: boolean;
        my_home: string;
        my_lcldata: string;
        new_rel_url: string | null;
        new_release: string | null;
        nt?: boolean;
        pause_int: string;
        paused: boolean;
        paused_all: boolean;
        pid: number;
        power_options: boolean;
        pp_pause_event: boolean;
        publicipv4?: string | null;
        pystone: number;
        quota: string;
        restart_req?: boolean;
        rtl: boolean;
        servers: SabStatusServer[];
        speedlimit: string;
        speedlimit_abs: string;
        uptime: string;
        url_base: string;
        version: string;
        warnings: SabWarning[];
        webdir: string;
        weblogfile: string | null;
        windows: boolean;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index
    active_lang active_socks5_proxy? apikey cache_art cache_buster cache_size color_scheme completedir completedirspeed configfn confighelpuri cpumodel? darwin? delayed_assembler diskspace1 diskspace1_norm diskspace2 diskspace2_norm diskspacetotal1 diskspacetotal2 dnslookup? downloaddir downloaddirspeed finishaction folders have_quota have_warnings internetbandwidth ipv6? left_quota loadavg localipv4? logfile loglevel macos my_home my_lcldata new_rel_url new_release nt? pause_int paused paused_all pid power_options pp_pause_event publicipv4? pystone quota restart_req? rtl servers speedlimit speedlimit_abs uptime url_base version warnings webdir weblogfile windows
    active_lang: string
    active_socks5_proxy?: string | null
    apikey: string
    cache_art: string
    cache_buster: string
    cache_size: string
    color_scheme: string
    completedir: string
    completedirspeed: number
    configfn: string
    confighelpuri: string
    cpumodel?: string

    Not returned by current SABnzbd releases.

    darwin?: boolean

    Not returned by current SABnzbd releases, use macos.

    delayed_assembler: number
    diskspace1: string

    Free space in GB for the download folder.

    diskspace1_norm: string
    diskspace2: string

    Free space in GB for the complete folder.

    diskspace2_norm: string
    diskspacetotal1: string

    Total space in GB for the download folder.

    diskspacetotal2: string

    Total space in GB for the complete folder.

    dnslookup?: boolean
    downloaddir: string
    downloaddirspeed: number
    finishaction: string | null

    Action to run when the queue finishes, null when none.

    folders: string[]
    have_quota: boolean
    have_warnings: string
    internetbandwidth: number
    ipv6?: string | null
    left_quota: string
    loadavg: string
    localipv4?: string

    Only present when not using skip_dashboard.

    logfile: string
    loglevel: string
    macos: boolean
    my_home: string
    my_lcldata: string
    new_rel_url: string | null
    new_release: string | null

    Newer release version, null when up to date.

    nt?: boolean

    Not returned by current SABnzbd releases, use windows.

    pause_int: string

    Remaining timed pause ("4:59"), "0" when not paused for an interval.

    paused: boolean
    paused_all: boolean
    pid: number
    power_options: boolean
    pp_pause_event: boolean

    Whether a scheduled post-processing pause/resume exists. This is not the current post-processing pause state, which SABnzbd does not expose.

    publicipv4?: string | null
    pystone: number
    quota: string
    restart_req?: boolean

    Not returned by current SABnzbd releases.

    rtl: boolean
    servers: SabStatusServer[]
    speedlimit: string

    Speed limit as a percentage of the configured maximum line speed.

    speedlimit_abs: string

    Absolute speed limit in bytes per second, "0" when unlimited.

    uptime: string
    url_base: string
    version: string
    warnings: SabWarning[]
    webdir: string
    weblogfile: string | null
    windows: boolean

    Settings
    Member Visibility

    On This Page
    Properties