Interface DownloadByNameRequest

Request parameters for downloading a file by bucket name and file name via b2_download_file_by_name.

interface DownloadByNameRequest {
    b2CacheControl?: string;
    b2ContentDisposition?: string;
    b2ContentEncoding?: string;
    b2ContentLanguage?: string;
    b2ContentType?: string;
    b2Expires?: string;
    bucketName: string;
    fileName: string;
    range?: string;
    serverSideEncryption?: {
        algorithm: "AES256";
        customerKey: string;
        customerKeyMd5: string;
    };
}

Index

Properties

b2CacheControl? b2ContentDisposition? b2ContentEncoding? b2ContentLanguage? b2ContentType? b2Expires? bucketName fileName range? serverSideEncryption?

Properties

`Optional` `Readonly`b2CacheControl

b2CacheControl?: string

Override the Cache-Control header in the download response.

`Optional` `Readonly`b2ContentDisposition

b2ContentDisposition?: string

Override the Content-Disposition header in the download response.

`Optional` `Readonly`b2ContentEncoding

b2ContentEncoding?: string

Override the Content-Encoding header in the download response.

`Optional` `Readonly`b2ContentLanguage

b2ContentLanguage?: string

Override the Content-Language header in the download response.

`Optional` `Readonly`b2ContentType

b2ContentType?: string

Override the Content-Type header in the download response.

`Optional` `Readonly`b2Expires

b2Expires?: string

Override the Expires header in the download response.

`Readonly`bucketName

bucketName: string

Name of the bucket containing the file.

`Readonly`fileName

fileName: string

Full path and name of the file within the bucket.

`Optional` `Readonly`range

range?: string

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

`Optional` `Readonly`serverSideEncryption

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.

Interface DownloadByNameRequest

Index

Properties

Properties

`Optional` `Readonly`b2CacheControl

`Optional` `Readonly`b2ContentDisposition

`Optional` `Readonly`b2ContentEncoding

`Optional` `Readonly`b2ContentLanguage

`Optional` `Readonly`b2ContentType

`Optional` `Readonly`b2Expires

`Readonly`bucketName

`Readonly`fileName

`Optional` `Readonly`range

`Optional` `Readonly`serverSideEncryption

Type Declaration

`Readonly`algorithm: "AES256"

`Readonly`customerKey: string

`Readonly`customerKeyMd5: string

Settings

On This Page

Interface DownloadByNameRequest

Index

Properties

Properties

Optional Readonlyb2CacheControl

Optional Readonlyb2ContentDisposition

Optional Readonlyb2ContentEncoding

Optional Readonlyb2ContentLanguage

Optional Readonlyb2ContentType

Optional Readonlyb2Expires

ReadonlybucketName

ReadonlyfileName

Optional Readonlyrange

Optional ReadonlyserverSideEncryption

Type Declaration

Readonlyalgorithm: "AES256"

ReadonlycustomerKey: string

ReadonlycustomerKeyMd5: string

Settings

On This Page

`Optional` `Readonly`b2CacheControl

`Optional` `Readonly`b2ContentDisposition

`Optional` `Readonly`b2ContentEncoding

`Optional` `Readonly`b2ContentLanguage

`Optional` `Readonly`b2ContentType

`Optional` `Readonly`b2Expires

`Readonly`bucketName

`Readonly`fileName

`Optional` `Readonly`range

`Optional` `Readonly`serverSideEncryption

`Readonly`algorithm: "AES256"

`Readonly`customerKey: string

`Readonly`customerKeyMd5: string