Backblaze B2

Backblaze B2 via the S3-compatible API. Endpoint derived from the cluster code (us-west-002, us-east-005, eu-central-003, ...).

Installation

@aws-sdk/client-s3, @aws-sdk/s3-presigned-post, and @aws-sdk/s3-request-presigner are optional peer dependencies of files-sdk - install alongside the SDK so the adapter's imports resolve at runtime.

npm install files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

Usage

import { Files } from "files-sdk";
import { backblazeB2 } from "files-sdk/backblaze-b2";

const files = new Files({
  adapter: backblazeB2({
    bucket: "uploads",
    region: "us-west-002", // or "us-east-005", "eu-central-003", ...
    // accessKeyId / secretAccessKey auto-loaded from
    // B2_APPLICATION_KEY_ID / B2_APPLICATION_KEY
  }),
});

Backblaze B2 via its S3-compatible API. A thin wrapper around the S3 adapter - endpoint derived from the cluster code (us-west-002, us-east-005, eu-central-003, ...), virtual-hosted-style addressing, errors relabelled. Auto-loads from B2_APPLICATION_KEY_ID and B2_APPLICATION_KEY. Generate an application key in the Backblaze console under Account -> Application Keys; the bucket's cluster is shown next to its endpoint.

Options

Prop

Type

Compatibility

MethodStatusNotes
upload
download
delete
list
search
head
exists
copy
url
signedUploadUrl

On this page