@ctrl/nzbget
    Preparing search index...

    Interface NzbGetStatus

    interface NzbGetStatus {
        ArticleCacheHi?: number;
        ArticleCacheLo?: number;
        ArticleCacheMB?: number;
        AverageDownloadRate: number;
        AverageDownloadRateHi?: number;
        AverageDownloadRateLo?: number;
        DaySizeHi?: number;
        DaySizeLo?: number;
        DaySizeMB?: number;
        Download2Paused?: boolean;
        DownloadedSizeHi: number;
        DownloadedSizeLo: number;
        DownloadedSizeMB?: number;
        DownloadLimit: number;
        DownloadPaused: boolean;
        DownloadRate: number;
        DownloadRateHi?: number;
        DownloadRateLo?: number;
        DownloadTimeSec?: number;
        FeedActive?: boolean;
        ForcedSizeHi?: number;
        ForcedSizeLo?: number;
        ForcedSizeMB?: number;
        FreeDiskSpaceHi?: number;
        FreeDiskSpaceLo?: number;
        FreeDiskSpaceMB?: number;
        FreeInterDiskSpaceHi?: number;
        FreeInterDiskSpaceLo?: number;
        FreeInterDiskSpaceMB?: number;
        MonthSizeHi?: number;
        MonthSizeLo?: number;
        MonthSizeMB?: number;
        NewsServers?: NzbGetNewsServerStatus[];
        ParJobCount?: number;
        PostJobCount?: number;
        PostPaused?: boolean;
        QueueScriptCount?: number;
        QuotaReached?: boolean;
        RemainingSizeHi: number;
        RemainingSizeLo: number;
        RemainingSizeMB?: number;
        ResumeTime?: number;
        ScanPaused?: boolean;
        ServerPaused?: boolean;
        ServerStandBy?: boolean;
        ServerTime?: number;
        ThreadCount?: number;
        TotalDiskSpaceHi?: number;
        TotalDiskSpaceLo?: number;
        TotalDiskSpaceMB?: number;
        TotalInterDiskSpaceHi?: number;
        TotalInterDiskSpaceLo?: number;
        TotalInterDiskSpaceMB?: number;
        UpTimeSec?: number;
        UrlCount?: number;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    ArticleCacheHi? ArticleCacheLo? ArticleCacheMB? AverageDownloadRate AverageDownloadRateHi? AverageDownloadRateLo? DaySizeHi? DaySizeLo? DaySizeMB? Download2Paused? DownloadedSizeHi DownloadedSizeLo DownloadedSizeMB? DownloadLimit DownloadPaused DownloadRate DownloadRateHi? DownloadRateLo? DownloadTimeSec? FeedActive? ForcedSizeHi? ForcedSizeLo? ForcedSizeMB? FreeDiskSpaceHi? FreeDiskSpaceLo? FreeDiskSpaceMB? FreeInterDiskSpaceHi? FreeInterDiskSpaceLo? FreeInterDiskSpaceMB? MonthSizeHi? MonthSizeLo? MonthSizeMB? NewsServers? ParJobCount? PostJobCount? PostPaused? QueueScriptCount? QuotaReached? RemainingSizeHi RemainingSizeLo RemainingSizeMB? ResumeTime? ScanPaused? ServerPaused? ServerStandBy? ServerTime? ThreadCount? TotalDiskSpaceHi? TotalDiskSpaceLo? TotalDiskSpaceMB? TotalInterDiskSpaceHi? TotalInterDiskSpaceLo? TotalInterDiskSpaceMB? UpTimeSec? UrlCount?
    ArticleCacheHi?: number

    Current article-cache usage, high 32 bits.

    ArticleCacheLo?: number

    Current article-cache usage, low 32 bits.

    ArticleCacheMB?: number

    Current article-cache usage in megabytes.

    AverageDownloadRate: number

    Average download speed since server start in bytes per second.

    Since v24.2. Use AverageDownloadRateLo/AverageDownloadRateHi.

    AverageDownloadRateHi?: number

    v24.2 Average download speed since server start, high 32 bits.

    AverageDownloadRateLo?: number

    v24.2 Average download speed since server start, low 32 bits.

    DaySizeHi?: number

    Downloaded today, high 32 bits.

    DaySizeLo?: number

    Downloaded today, low 32 bits.

    DaySizeMB?: number

    Downloaded today in megabytes.

    Download2Paused?: boolean

    Deprecated second download pause flag.

    DownloadedSizeHi: number

    Amount downloaded since server start in bytes, high 32 bits.

    DownloadedSizeLo: number

    Amount downloaded since server start in bytes, low 32 bits.

    DownloadedSizeMB?: number

    Amount downloaded since server start in megabytes.

    DownloadLimit: number

    Current download limit in bytes per second.

    DownloadPaused: boolean

    True if the download queue is soft-paused.

    DownloadRate: number

    Current download speed in bytes per second.

    Since v24.2, int32 and overflows above 2 GB/s. Use DownloadRateLo/DownloadRateHi.

    DownloadRateHi?: number

    v24.2 Current download speed in bytes per second, high 32 bits.

    DownloadRateLo?: number

    v24.2 Current download speed in bytes per second, low 32 bits.

    DownloadTimeSec?: number

    Server download time in seconds.

    FeedActive?: boolean

    True if any RSS feed is currently active.

    ForcedSizeHi?: number

    Remaining forced-priority size, high 32 bits.

    ForcedSizeLo?: number

    Remaining forced-priority size, low 32 bits.

    ForcedSizeMB?: number

    Remaining forced-priority size in megabytes.

    FreeDiskSpaceHi?: number

    Free disk space on the DestDir drive, high 32 bits.

    FreeDiskSpaceLo?: number

    Free disk space on the DestDir drive, low 32 bits.

    FreeDiskSpaceMB?: number

    Free disk space on the DestDir drive in megabytes.

    FreeInterDiskSpaceHi?: number

    Free disk space on the InterDir drive, high 32 bits.

    FreeInterDiskSpaceLo?: number

    Free disk space on the InterDir drive, low 32 bits.

    FreeInterDiskSpaceMB?: number

    Free disk space on the InterDir drive in megabytes.

    MonthSizeHi?: number

    Downloaded this month (since QuotaStartDay), high 32 bits.

    MonthSizeLo?: number

    Downloaded this month (since QuotaStartDay), low 32 bits.

    MonthSizeMB?: number

    Downloaded this month (since QuotaStartDay) in megabytes.

    NewsServers?: NzbGetNewsServerStatus[]

    Per-server enabled/disabled state.

    ParJobCount?: number

    Deprecated par job count.

    PostJobCount?: number

    Number of jobs in post-processing queue.

    PostPaused?: boolean

    True if post-processing queue is paused.

    QueueScriptCount?: number

    Number of queued or running queue-scripts.

    QuotaReached?: boolean

    True when the monthly or daily download quota is reached.

    RemainingSizeHi: number

    Remaining queue size in bytes, high 32 bits of the 64-bit value.

    RemainingSizeLo: number

    Remaining queue size in bytes, low 32 bits of the 64-bit value.

    RemainingSizeMB?: number

    Remaining queue size in megabytes.

    ResumeTime?: number

    Scheduled resume time in Unix seconds.

    ScanPaused?: boolean

    True if scan queue is paused.

    ServerPaused?: boolean

    Deprecated server pause flag.

    ServerStandBy?: boolean

    True when there are no active downloads.

    ServerTime?: number

    Current server time in Unix seconds.

    ThreadCount?: number

    Number of running threads.

    TotalDiskSpaceHi?: number

    Total disk space on the DestDir drive, high 32 bits.

    TotalDiskSpaceLo?: number

    Total disk space on the DestDir drive, low 32 bits.

    TotalDiskSpaceMB?: number

    Total disk space on the DestDir drive in megabytes.

    TotalInterDiskSpaceHi?: number

    Total disk space on the InterDir drive, high 32 bits.

    TotalInterDiskSpaceLo?: number

    Total disk space on the InterDir drive, low 32 bits.

    TotalInterDiskSpaceMB?: number

    Total disk space on the InterDir drive in megabytes.

    UpTimeSec?: number

    Server uptime in seconds.

    UrlCount?: number

    Number of URLs in URL queue.

    Settings
    Member Visibility

    On This Page
    Properties