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

    Interface UploadFileHeaders

    Headers required when uploading a file via b2_upload_file. Sent as HTTP headers on the upload POST request.

    Pass contentDisposition, contentLanguage, expires, cacheControl, and contentEncoding as raw (unencoded) download-header values. The SDK percent-encodes them as B2 file-info metadata when uploading.

    interface UploadFileHeaders {
        authorization: string;
        cacheControl?: string;
        contentDisposition?: string;
        contentEncoding?: string;
        contentLanguage?: string;
        contentLength: number;
        contentSha1: string;
        contentType: string;
        customUploadTimestamp?: number;
        expires?: string;
        fileInfo?: Record<string, string>;
        fileName: string;
        fileRetention?: FileRetentionValue;
        lastModifiedMillis?: number;
        legalHold?: LegalHoldValue;
        serverSideEncryption?: EncryptionSetting;
    }
    Index
    authorization cacheControl? contentDisposition? contentEncoding? contentLanguage? contentLength contentSha1 contentType customUploadTimestamp? expires? fileInfo? fileName fileRetention? lastModifiedMillis? legalHold? serverSideEncryption?
    authorization: string

    Authorization token from b2_get_upload_url.

    cacheControl?: string

    Optional Cache-Control header value for downloads.

    contentDisposition?: string

    Optional Content-Disposition header value for downloads.

    contentEncoding?: string

    Optional Content-Encoding header value for downloads.

    contentLanguage?: string

    Optional Content-Language header value for downloads.

    contentLength: number

    Size of the file content in bytes.

    contentSha1: string

    SHA-1 checksum of the content, or 'hex_digits_at_end' / 'do_not_verify' for deferred verification.

    contentType: string

    MIME type of the file. Use 'b2/x-auto' for automatic detection.

    customUploadTimestamp?: number

    Optional B2 upload timestamp override in milliseconds since epoch. Sets the file version uploadTimestamp; distinct from lastModifiedMillis metadata. Requires B2 account enablement for Custom Upload Timestamp.

    expires?: string

    Optional Expires header value for downloads.

    fileInfo?: Record<string, string>

    Optional user-defined key-value metadata for the file.

    fileName: string

    URL-encoded file name including path within the bucket.

    fileRetention?: FileRetentionValue

    Optional Object Lock retention for the file.

    lastModifiedMillis?: number

    Optional last-modified timestamp in milliseconds (stored as src_last_modified_millis in file info).

    legalHold?: LegalHoldValue

    Optional legal hold for the file.

    serverSideEncryption?: EncryptionSetting

    Optional server-side encryption setting.

    Settings
    Member Visibility

    On This Page
    Properties