@backblaze-labs/b2-sdk - v0.1.0
    Preparing search index...

    Interface UpdateFileRetentionRequest

    Request parameters for the b2_update_file_retention API call. Updates the Object Lock retention settings on a file version.

    interface UpdateFileRetentionRequest {
        bypassGovernance?: boolean;
        fileId: FileId;
        fileName: string;
        fileRetention: FileRetentionValue;
    }
    Index

    Properties

    bypassGovernance? fileId fileName fileRetention

    Properties

    bypassGovernance?: boolean

    When true, allows shortening a governance-mode retention period. Requires the bypassGovernance capability on the application key. Has no effect on compliance-mode retention.

    fileId: FileId

    ID of the file version to update.

    fileName: string

    Name of the file to update.

    fileRetention: FileRetentionValue

    New retention settings for the file.

    Settings

    Member Visibility

    On This Page

    Properties