Backblaze B2 Storage Driver Documentation

Backblaze is an online backup tool that allows Windows and Mac OS X users to back up their data to an offsite data center.

Backblaze B2 is their cloud object storage offering similar to Amazon S3 and other object storage services.


Keep in mind that the service is currently in public beta and only users who have signed up and received beta access can use it. To sign up for the beta access, visit their website mentioned above.

Instantiating a driver

To instantiate the driver you need to pass your account id and application key to the driver constructor as shown below.

To access the account id, once we have admitted you into the beta you can login to, then click “buckets” and “show account id and application key”.

from import Provider
from import get_driver

account_id = 'XXXXXX'
application_key = 'YYYYYY'

cls = get_driver(Provider.BACKBLAZE_B2)
driver = cls(account_id, application_key)

API Docs

class, secret=None, secure=True, host=None, port=None, api_version=None, region=None, **kwargs)[source]
  • key (str) – API key or username to be used (required)
  • secret (str) – Secret password to be used (required)
  • secure (bool) – Whether to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default.
  • host (str) – Override hostname used for connections.
  • port (int) – Override port used for connections.
  • api_version (str) – Optional API version. Only used by drivers which support multiple API versions.
  • region (str) – Optional driver region. Only used by drivers which support multiple regions.
Return type:



Enable container CDN.

Parameters:container (Container) – Container instance
Return type:bool

Enable object CDN.

Parameters:obj (Object) – Object instance
Return type:bool

Retrieve information used for uploading files (upload url, auth token, etc).


Retrieve URL used for file uploads.

Return type:str

Return a container CDN URL.

Parameters:container (Container) – Container instance
Returns:A CDN URL for this container.
Return type:str

Return an object CDN URL.

Parameters:obj (Object) – Object instance
Returns:A CDN URL for this object.
Return type:str

Return a list of objects for the given container.

Parameters:container (Container) – Container instance.
Returns:A list of Object instances.
Return type:list of Object

Return a list of containers.

Returns:A list of Container instances.
Return type:list of Container
upload_object(file_path, container, object_name, extra=None, verify_hash=True, headers=None)[source]

Upload an object.

Note: This will override file with a same name if it already exists.

upload_object_via_stream(iterator, container, object_name, extra=None, headers=None)[source]

Upload an object.

Note: Backblaze does not yet support uploading via stream, so this calls upload_object internally requiring the object data to be loaded into memory at once