@truenas/api-client
    Preparing search index...

    Interface ApiVersion

    Parsed API version information

    Version format:

    • Legacy (v25.x): vYY.MM.PATCH (e.g., v25.10.0 = October 2025, patch 0)
    • New (v26+): vYY.MINOR.PATCH (e.g., v26.0.0 = 2026, minor 0, patch 0)

    Note: The second segment has different semantics based on the year:

    • Year 25: month (1-12)
    • Year 26+: minor version (0-99)
    interface ApiVersion {
        minor: number;
        patch: number;
        version: string;
        websocketPath: string;
        year: number;
    }
    Index
    minor patch version websocketPath year
    minor: number

    Second version segment (semantics depend on year):

    • For v25.x: month (1-12, e.g., 10 = October)
    • For v26+: minor version (0-99)
    patch: number

    Patch version number (e.g., 0, 1, 2)

    version: string

    Full version string (e.g., "v26.0.0")

    websocketPath: string

    WebSocket path for this version (e.g., "/api/v26.0.0")

    year: number

    Two-digit year (e.g., 26 = 2026)

    Settings
    Member Visibility

    On This Page
    Properties