BackblazeVFS mounts one bucket: every object becomes a file and every / in
a key a folder. It is the S3 VFS pointed at Backblaze B2’s
endpoint, so commands behave as they do on S3. Set up credentials as in Backblaze B2 setup.
Install
Configure
region also picks the endpoint, https://s3.<region>.backblazeb2.com,
as the bucket’s Endpoint shows it in the Backblaze console; endpoint_url
replaces it.
A mount takes MountMode.READ, WRITE or EXEC.
Fields
Seconds a request may wait to connect, or between two reads of its answer, before it fails; a download that keeps flowing is never cut off.
Provider region every request is signed for. Most providers also build their endpoint URL from it unless
endpoint_url is set.Named profile in the shared AWS config and credentials files that supplies credentials when no access key pair is given.
Address the bucket in the URL path (
<endpoint>/<bucket>/<key>) instead of as a subdomain of the endpoint.Key prefix inside the bucket that the mount treats as its root; keys outside it are not visible. Leading slashes are dropped and a trailing
/ is added.Authentication
Credentials come from the first of:access_key_idandsecret_access_key, withsession_tokenfor temporary credentials.aws_profile, a profile in~/.aws/credentials.- The AWS credential chain: environment variables, then the instance or container role.
access_key_id takes the application key’s keyID and secret_access_key its applicationKey.
The key needs Read Only on the bucket, or Read and Write for a
write mount, with Allow List All Bucket Names ticked. The master
application key does not work with the S3-compatible API, and neither
does a key created before May 4, 2020.
An object the key may not read or change answers Permission denied.
Layout
/b2/reports/2026-q3.csv is the key reports/2026-q3.csv. Folders come
from the / in keys.
Behavior
- Key prefix:
key_prefix="users/42/"mounts only that part of the bucket, so/b2/notes.mdis the keyusers/42/notes.md.
Integration
Backblaze B2 answers these commands through its own API, so fewer objects are read. See Integration.find: one recursive listing.du: one recursive listing.ls -Randtree: one recursive listing.
VFS.md
The VFS.md an agent reads with Backblaze B2 mounted at/<path>.
<mode> is the mount’s mode: read, write or exec. The commands shown are
those of a write mount.
- Rendered
- Raw
Virtual Filesystem
Supported Unix Commands for VFSUnix commands work on each path as on a local filesystem, as far as the path supports them:
Limitations of Unix Commands for VFSWhere a path differs from a local filesystem:
Run
man <cmd> or <cmd> --help for one command’s usage.