@backblaze-labs/b2-mcp
    Preparing search index...

    Interface UpdateFileRetentionOptions

    Options for updating Object Lock retention on a specific B2 file version.

    interface UpdateFileRetentionOptions {
        bypassGovernance?: boolean;
        fileId: string;
        fileName: string;
        fileRetention: {
            mode: "governance" | "compliance" | null;
            retainUntilTimestamp: number | null;
        };
    }
    Index
    bypassGovernance? fileId fileName fileRetention
    bypassGovernance?: boolean

    Whether to request governance-mode bypass.

    fileId: string

    B2 file ID for the version to update.

    fileName: string

    B2 file name for the version to update.

    fileRetention: {
        mode: "governance" | "compliance" | null;
        retainUntilTimestamp: number | null;
    }

    Desired file-retention policy.

    Type Declaration

    • mode: "governance" | "compliance" | null

      Retention mode, or null to remove retention when allowed.

    • retainUntilTimestamp: number | null

      Retain-until timestamp in milliseconds since epoch, or null.

    Settings
    Member Visibility

    On This Page
    Properties