Skip to main content
Every object in an existing Backblaze B2 bucket becomes a file, and every / in a key becomes a folder.

Setup

Create an application key in the Backblaze web console, then export it.
  1. Under B2 Cloud Storage, open Application Keys and click Add a New Application Key.
  2. In Allow Access to Bucket(s), pick the bucket and tick Allow List All Bucket Names.
  3. Pick Read Only, or Read and Write for a write mount, then click Create New Key.
  4. Copy the keyID (the access key ID) and the applicationKey (the secret access key). The applicationKey is shown only once.
  5. Read the region off the bucket’s Endpoint, s3.<region>.backblazeb2.com, for example us-west-004.
The master application key does not work with the S3-compatible API, and neither does a key created before May 4, 2020.

Connect

workspace.yaml

Layout

  • The endpoint comes from region: s3.<region>.backblazeb2.com. endpoint_url (endpoint in TypeScript) overrides it.
  • key_prefix (keyPrefix in TypeScript) mounts one folder of the bucket as the root.
  • grep -r, find and du stop after 1000 files; a glob matching more, tar -c, cp -r and rm -r are refused.

Sample runs

On a write mount, cp, mv, rm and > change objects in the bucket. For write: conditional, see S3-compatible VFSes.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.