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

    Interface DownloadByIdRequest

    Request parameters for downloading a file by its ID via b2_download_file_by_id.

    interface DownloadByIdRequest {
        b2CacheControl?: string;
        b2ContentDisposition?: string;
        b2ContentEncoding?: string;
        b2ContentLanguage?: string;
        b2ContentType?: string;
        b2Expires?: string;
        fileId: FileId;
        range?: string;
        serverSideEncryption?: {
            algorithm: "AES256";
            customerKey: string;
            customerKeyMd5: string;
        };
    }
    Index

    Properties

    b2CacheControl? b2ContentDisposition? b2ContentEncoding? b2ContentLanguage? b2ContentType? b2Expires? fileId range? serverSideEncryption?

    Properties

    b2CacheControl?: string

    Override the Cache-Control header in the download response.

    b2ContentDisposition?: string

    Override the Content-Disposition header in the download response.

    b2ContentEncoding?: string

    Override the Content-Encoding header in the download response.

    b2ContentLanguage?: string

    Override the Content-Language header in the download response.

    b2ContentType?: string

    Override the Content-Type header in the download response.

    b2Expires?: string

    Override the Expires header in the download response.

    fileId: FileId

    ID of the file version to download.

    range?: string

    Optional byte range to download (e.g., 'bytes=0-999').

    serverSideEncryption?: {
        algorithm: "AES256";
        customerKey: string;
        customerKeyMd5: string;
    }

    SSE-C decryption parameters, required if the file was uploaded with SSE-C.

    Type Declaration

    • Readonlyalgorithm: "AES256"

      Encryption algorithm. Always 'AES256'.

    • ReadonlycustomerKey: string

      Base64-encoded customer-provided decryption key.

    • ReadonlycustomerKeyMd5: string

      Base64-encoded MD5 digest of the decryption key.

    Settings

    Member Visibility

    On This Page

    Properties