BackblazeB2 Class

Properties   Methods   Events   Config Settings   Errors  

The BackblazeB2 class offers an easy to use interface for Backblaze's B2 Cloud Storage service.

Syntax

class cloudstorage.BackblazeB2

Remarks

The BackblazeB2 class provides an easy-to-use API for the Backblaze B2 Cloud Storage service. Capabilities include uploading and downloading files, bucket management, strong encryption support, and more.

Authentication

Authentication works by exchanging a known application key (which consists of a key Id and the key string itself) for an authorization token which is then used to authorize all further requests. The authentication process also returns information about the account, the capabilities and restrictions associated with the application key, and other details that help the class interact with the Backblaze B2 API.

To authenticate the class with the server, supply an application key using the application_key_id and application_key properties, and then call authorize. This will populate the Account* properties with the aforementioned information, including the account_auth_token.

Eventually, the authorization token returned during the authentication process will expire, at which point it should be exchanged for a new one by calling authorize again.

Usage

Once authenticated, you can start interacting with the Backblaze B2 Cloud Storage service. The following list shows some of the methods used to accomplish common tasks:

• Bucket management: list_buckets, get_bucket_info, create_bucket, update_bucket, delete_bucket
• File management: list_files, list_file_versions, get_file_info, upload_file, copy_file, download_file, download_file_by_id, hide_file, delete_file, delete_file_version
• Multipart uploads: list_multipart_uploads, start_multipart_upload, complete_multipart_upload, abort_multipart_upload, list_parts, upload_part, copy_part
• Application key management: list_app_keys, create_app_key, delete_app_key
• Sharing files: get_download_auth_token

Refer to the complete API, below, for more information.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

account_id Property

The Id of the account.

Syntax

def get_account_id() -> str: ...

account_id = property(get_account_id, None)

Default Value

""

Remarks

The Id of the account.

This property reflects the Id of the account that the currently-authenticated application key belongs to.

This property is read-only.

account_allowed_bucket_id Property

The Id of the bucket that the application key is restricted to.

Syntax

def get_account_allowed_bucket_id() -> str: ...

account_allowed_bucket_id = property(get_account_allowed_bucket_id, None)

Default Value

""

Remarks

The Id of the bucket that the application key is restricted to.

This property reflects the Id of the bucket that the currently-authenticated application key is restricted to. It will be empty if the currently-authenticated application key is not restricted to any specific bucket.

This property is read-only.

account_allowed_bucket_name Property

The name of the bucket that the application key is restricted to.

Syntax

def get_account_allowed_bucket_name() -> str: ...

account_allowed_bucket_name = property(get_account_allowed_bucket_name, None)

Default Value

""

Remarks

The name of the bucket that the application key is restricted to.

This property reflects the name of the bucket that the currently-authenticated application key is restricted to. It will be empty if the currently-authenticated application key is not restricted to any specific bucket; or if it is, but the bucket has been deleted (account_allowed_bucket_id will still be populated in this case).

This property is read-only.

account_allowed_prefix Property

The file name prefix that the application key is restricted to.

Syntax

def get_account_allowed_prefix() -> str: ...

account_allowed_prefix = property(get_account_allowed_prefix, None)

Default Value

""

Remarks

The file name prefix that the application key is restricted to.

This property reflects the file name prefix that the currently-authenticated application key is restricted to. It will be empty if the currently-authenticated application key is not restricted to a specific file name prefix.

This property is read-only.

account_auth_token Property

The authorization token that will be used to authorize requests.

Syntax

def get_account_auth_token() -> str: ...

account_auth_token = property(get_account_auth_token, None)

Default Value

""

Remarks

The authorization token that will be used to authorize requests.

This property reflects the actual authorization token that will be used to authorize requests sent to the server. This token is obtained by calling authorize to authenticate to the server using the current application_key and application_key_id values; it is valid for up to 24 hours.

This property is read-only.

account_capabilities Property

The capabilities that the application key has.

Syntax

def get_account_capabilities() -> str: ...

account_capabilities = property(get_account_capabilities, None)

Default Value

""

Remarks

The capabilities that the application key has.

This property reflects the capabilities that the currently-authenticated application key has. It is formatted as a comma-separated list of one or more of the following strings:

This property is read-only.

account_min_part_size Property

The minimum allowed multipart upload part size.

Syntax

def get_account_min_part_size() -> int: ...

account_min_part_size = property(get_account_min_part_size, None)

Default Value

-1

Remarks

The minimum allowed multipart upload part size.

This property reflects the minimum allowed multipart upload part size, in bytes.

This property is read-only.

account_rec_part_size Property

The recommended multipart upload part size.

Syntax

def get_account_rec_part_size() -> int: ...

account_rec_part_size = property(get_account_rec_part_size, None)

Default Value

-1

Remarks

The recommended multipart upload part size.

This property reflects the recommended multipart upload part size, in bytes.

This property is read-only.

app_key_marker Property

A marker indicating what page of application keys to return next.

Syntax

def get_app_key_marker() -> str: ...
def set_app_key_marker(value: str) -> None: ...

app_key_marker = property(get_app_key_marker, set_app_key_marker)

Default Value

""

Remarks

This property will be populated when list_app_keys is called if the results are paged and there are more pages. To list all application keys, continue to call list_app_keys until this property returns empty string.

Refer to list_app_keys for more information.

app_key_count Property

The number of records in the AppKey arrays.

Syntax

def get_app_key_count() -> int: ...

app_key_count = property(get_app_key_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• app_key_allowed_bucket_id
• app_key_allowed_prefix
• app_key_capabilities
• app_key_expiration_time
• app_key_id
• app_key_name

The array indices start at 0 and end at app_key_count - 1.

This property is read-only.

app_key_allowed_bucket_id Property

The Id of the bucket that the application key is restricted to.

Syntax

def get_app_key_allowed_bucket_id(app_key_index: int) -> str: ...

Default Value

""

Remarks

The Id of the bucket that the application key is restricted to.

This property reflects the Id of the bucket that the application key is restricted to. It will be empty if the application key is not restricted to any specific bucket.

The app_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the app_key_count property.

This property is read-only.

app_key_allowed_prefix Property

The file name prefix that the application key is restricted to.

Syntax

def get_app_key_allowed_prefix(app_key_index: int) -> str: ...

Default Value

""

Remarks

The file name prefix that the application key is restricted to.

This property reflects the file name prefix that the application key is restricted to. It will be empty if the application key is not restricted to a specific file name prefix.

The app_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the app_key_count property.

This property is read-only.

app_key_capabilities Property

The capabilities that the application key has.

Syntax

def get_app_key_capabilities(app_key_index: int) -> str: ...

Default Value

""

Remarks

The capabilities that the application key has.

This property reflects the capabilities that the application key has. It is formatted as a comma-separated list of one or more of the following:

The app_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the app_key_count property.

This property is read-only.

app_key_expiration_time Property

The application key's expiration time.

Syntax

def get_app_key_expiration_time(app_key_index: int) -> int: ...

Default Value

-1

Remarks

The application key's expiration time.

This property reflects the expiration time of the application key, in milliseconds relative to the Unix epoch. It will be -1 if the application key does not expire.

The app_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the app_key_count property.

This property is read-only.

app_key_id Property

The Id of the application key.

Syntax

def get_app_key_id(app_key_index: int) -> str: ...

Default Value

""

Remarks

The Id of the application key.

This property reflects the unique Id of the application key.

The app_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the app_key_count property.

This property is read-only.

app_key_name Property

The name of the application key.

Syntax

def get_app_key_name(app_key_index: int) -> str: ...

Default Value

""

Remarks

The name of the application key.

This property reflects the name assigned to the application key when it was created. Application key names are not used for identification, so there is no requirement for them to be unique.

The app_key_index parameter specifies the index of the item in the array. The size of the array is controlled by the app_key_count property.

This property is read-only.

application_key Property

The application key to use for authentication.

Syntax

def get_application_key() -> str: ...
def set_application_key(value: str) -> None: ...

application_key = property(get_application_key, set_application_key)

Default Value

""

Remarks

This property specifies the application key that should be used for authentication. Both this property and application_key_id must be set before attempting any operations which connect to the server.

application_key_id Property

The application key Id to use for authentication.

Syntax

def get_application_key_id() -> str: ...
def set_application_key_id(value: str) -> None: ...

application_key_id = property(get_application_key_id, set_application_key_id)

Default Value

""

Remarks

This property specifies the application key Id that should be used for authentication. Both this property and application_key must be set before attempting any operations which connect to the server.

bucket_count Property

The number of records in the Bucket arrays.

Syntax

def get_bucket_count() -> int: ...

bucket_count = property(get_bucket_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• bucket_id
• bucket_kind
• bucket_name
• bucket_revision

The array indices start at 0 and end at bucket_count - 1.

This property is read-only.

bucket_id Property

The Id of the bucket.

Syntax

def get_bucket_id(bucket_index: int) -> str: ...

Default Value

""

Remarks

The Id of the bucket.

This property reflects the unique Id of the bucket.

The bucket_index parameter specifies the index of the item in the array. The size of the array is controlled by the bucket_count property.

This property is read-only.

bucket_kind Property

The kind of bucket.

Syntax

def get_bucket_kind(bucket_index: int) -> str: ...

Default Value

""

Remarks

The kind of bucket.

This property reflects the bucket's kind. Possible values are allPublic, allPrivate, or snapshot.

The bucket_index parameter specifies the index of the item in the array. The size of the array is controlled by the bucket_count property.

This property is read-only.

bucket_name Property

The name of the bucket.

Syntax

def get_bucket_name(bucket_index: int) -> str: ...

Default Value

""

Remarks

The name of the bucket.

This property reflects the name of the bucket.

The bucket_index parameter specifies the index of the item in the array. The size of the array is controlled by the bucket_count property.

This property is read-only.

bucket_revision Property

The revision number of the bucket.

Syntax

def get_bucket_revision(bucket_index: int) -> int: ...

Default Value

-1

Remarks

The revision number of the bucket.

This property reflects the bucket's revision number. A bucket's revision number is updated every time the bucket is modified.

The bucket_index parameter specifies the index of the item in the array. The size of the array is controlled by the bucket_count property.

This property is read-only.

content_type Property

The content type to send for a file.

Syntax

def get_content_type() -> str: ...
def set_content_type(value: str) -> None: ...

content_type = property(get_content_type, set_content_type)

Default Value

""

Remarks

This property can be set before calling upload_file, start_multipart_upload, or (if the SendMetadataOnCopy configuration setting is enabled) copy_file to have its value submitted as the file's Content-Type header value.

If this property is empty, the class will send b2/x-auto, which instructs the server to automatically determine the content type based on the file's extension (or set it to application/octet-stream if it cannot).

delimiter Property

The delimiter string to use when listing files.

Syntax

def get_delimiter() -> str: ...
def set_delimiter(value: str) -> None: ...

delimiter = property(get_delimiter, set_delimiter)

Default Value

""

Remarks

If this property is non-empty when list_files or list_file_versions is called, any items whose names contain the same string between the specified prefix and the first occurrence of the specified delimiter that follow will be rolled up into a virtual "folder" element, which is returned in place of the individual files themselves.

If a particular item is a "folder" instead of an actual file or file version, then the file_kind property will be set to folder. The same is also true of the on_file_list event's Kind parameter.

File Hierarchy Traversal

By using the delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With delimiter set to /, we can set prefix to successively "deeper" values before calling list_files or list_file_versions for the following effect:

encryption_algorithm Property

The encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

encryption_password Property

The encryption password.

Syntax

def get_encryption_password() -> str: ...
def set_encryption_password(value: str) -> None: ...

encryption_password = property(get_encryption_password, set_encryption_password)

Default Value

""

Remarks

If this property is populated when upload_file or download_file is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

file_data Property

The data that was downloaded, or that should be uploaded.

Syntax

def get_file_data() -> bytes: ...
def set_file_data(value: bytes) -> None: ...

file_data = property(get_file_data, set_file_data)

Default Value

""

Remarks

This property is populated with file data after calling download_file or download_file_by_id if local_file is not set.

This property can also be set before calling upload_file or upload_part; its data will be uploaded if local_file is not set.

file_marker Property

A marker indicating what page of files to return next.

Syntax

def get_file_marker() -> str: ...
def set_file_marker(value: str) -> None: ...

file_marker = property(get_file_marker, set_file_marker)

Default Value

""

Remarks

This property will be populated when list_files or list_multipart_uploads is called if the results are paged and there are more pages. To list all files or multipart uploads, continue to call list_files or list_multipart_uploads (respectively) until this property returns empty string.

Refer to list_files or list_multipart_uploads for more information.

file_count Property

The number of records in the File arrays.

Syntax

def get_file_count() -> int: ...

file_count = property(get_file_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• file_bucket_id
• file_content_type
• file_created_time
• file_id
• file_kind
• file_md5_hash
• file_modified_time
• file_name
• file_sha1_hash
• file_size

The array indices start at 0 and end at file_count - 1.

This property is read-only.

file_bucket_id Property

The Id of the bucket that the file is in.

Syntax

def get_file_bucket_id(file_index: int) -> str: ...

Default Value

""

Remarks

The Id of the bucket that the file is in.

This property reflects the Id of the bucket that the file is in.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_content_type Property

The content type of the file.

Syntax

def get_file_content_type(file_index: int) -> str: ...

Default Value

""

Remarks

The content type of the file.

This property reflects the content type of the file. Always application/x-bz-hide-marker when file_kind is hide; and empty when file_kind is folder.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_created_time Property

The file's creation time.

Syntax

def get_file_created_time(file_index: int) -> int: ...

Default Value

-1

Remarks

The file's creation time.

This property reflects the file's creation time, in milliseconds relative to the Unix epoch. Always 0 when file_kind is folder.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_id Property

The Id of the file.

Syntax

def get_file_id(file_index: int) -> str: ...

Default Value

""

Remarks

The Id of the file.

This property reflects the Id of the file. Always empty when file_kind is folder.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_kind Property

The kind of file.

Syntax

def get_file_kind(file_index: int) -> str: ...

Default Value

""

Remarks

The kind of file.

This property reflects the file's kind. Possible values are:

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_md5_hash Property

An MD5 hash of the file's contents.

Syntax

def get_file_md5_hash(file_index: int) -> str: ...

Default Value

""

Remarks

An MD5 hash of the file's contents.

This property reflects a hex-encoded MD5 hash of the file's contents, or empty string if such a hash is not available.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_modified_time Property

The file's last modified time.

Syntax

def get_file_modified_time(file_index: int) -> int: ...

Default Value

-1

Remarks

The file's last modified time.

This property reflects the file's last modified time, in milliseconds relative to the Unix epoch.

Note that this property will only be populated if a src_last_modified_millis metadata item is included for the file, and if that metadata item's value can be parsed as a 64-bit integer; otherwise, it will be -1. Refer to the ClientModifiedTime configuration setting for more information.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_name Property

The name of the file.

Syntax

def get_file_name(file_index: int) -> str: ...

Default Value

""

Remarks

The name of the file.

This property reflects the name of the file.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_sha1_hash Property

A SHA1 hash of the file's contents.

Syntax

def get_file_sha1_hash(file_index: int) -> str: ...

Default Value

""

Remarks

A SHA1 hash of the file's contents.

This property reflects a hex-encoded SHA1 hash of the file's contents, or empty string if such a hash is not available. Always empty if file_kind is folder or hide.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_size Property

The file's size.

Syntax

def get_file_size(file_index: int) -> int: ...

Default Value

0

Remarks

The file's size.

This property reflects the file's size, in bytes. Always 0 when file_kind is folder, hide, or start.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

local_file Property

The location of the local file.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling upload_file or upload_part; and as the destination file when calling download_file or download_file_by_id.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

metadata_count Property

The number of records in the Metadata arrays.

Syntax

def get_metadata_count() -> int: ...
def set_metadata_count(value: int) -> None: ...

metadata_count = property(get_metadata_count, set_metadata_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• metadata_name
• metadata_value

The array indices start at 0 and end at metadata_count - 1.

metadata_name Property

The name of the metadata item.

Syntax

def get_metadata_name(metadata_index: int) -> str: ...
def set_metadata_name(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the metadata item.

This property specifies the name of the metadata item. Metadata item names may be up to 50 characters in length, and must consist solely of letters, numbers, hyphens (-), and underscores (_). The server stores all metadata item names in lowercase.

A metadata item's name cannot start with b2- unless said name is one those explicitly defined by the Backblaze B2 API documentation. Keep in mind that the metadata_value of such a metadata item must comply with the format specified by the Backblaze B2 API documentation as well, otherwise the server will reject it.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_value Property

The value of the metadata item.

Syntax

def get_metadata_value(metadata_index: int) -> str: ...
def set_metadata_value(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

other_headers Property

This property includes other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

overwrite Property

Determines if local files are overwritten.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property controls whether local files are overwritten when calling download_file or download_file_by_id. It is only applicable to local files.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

part_marker Property

A marker indicating what page of parts to return next.

Syntax

def get_part_marker() -> str: ...
def set_part_marker(value: str) -> None: ...

part_marker = property(get_part_marker, set_part_marker)

Default Value

""

Remarks

This property will be populated when list_parts is called if the results are paged and there are more pages. To list all parts, continue to call list_parts until this property returns empty string.

Refer to list_parts for more information.

part_count Property

The number of records in the Part arrays.

Syntax

def get_part_count() -> int: ...

part_count = property(get_part_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• part_created_time
• part_md5_hash
• part_number
• part_sha1_hash
• part_size

The array indices start at 0 and end at part_count - 1.

This property is read-only.

part_created_time Property

The part's creation time.

Syntax

def get_part_created_time(part_index: int) -> int: ...

Default Value

-1

Remarks

The part's creation time.

This property reflects the part's creation time (i.e., upload time), in milliseconds relative to the Unix epoch.

The part_index parameter specifies the index of the item in the array. The size of the array is controlled by the part_count property.

This property is read-only.

part_md5_hash Property

An MD5 hash of the part's contents.

Syntax

def get_part_md5_hash(part_index: int) -> str: ...

Default Value

""

Remarks

An MD5 hash of the part's contents.

This property reflects a hex-encoded MD5 hash of the part's contents, or empty string if such a hash is not available.

The part_index parameter specifies the index of the item in the array. The size of the array is controlled by the part_count property.

This property is read-only.

part_number Property

The number of the part.

Syntax

def get_part_number(part_index: int) -> int: ...

Default Value

-1

Remarks

The number of the part.

This property specifies the number of the part. Must a be a value in the range 1 to 10000, inclusive.

The part_index parameter specifies the index of the item in the array. The size of the array is controlled by the part_count property.

This property is read-only.

part_sha1_hash Property

A SHA1 hash of the part's contents.

Syntax

def get_part_sha1_hash(part_index: int) -> str: ...

Default Value

""

Remarks

A SHA1 hash of the part's contents.

This property reflects a hex-encoded SHA1 hash of the part's contents.

The part_index parameter specifies the index of the item in the array. The size of the array is controlled by the part_count property.

This property is read-only.

part_size Property

The part's size.

Syntax

def get_part_size(part_index: int) -> int: ...

Default Value

0

Remarks

The part's size.

This property reflects the part's size, in bytes.

The part_index parameter specifies the index of the item in the array. The size of the array is controlled by the part_count property.

This property is read-only.

prefix Property

A prefix used to restrict the results returned when listing files.

Syntax

def get_prefix() -> str: ...
def set_prefix(value: str) -> None: ...

prefix = property(get_prefix, set_prefix)

Default Value

""

Remarks

This property, if non-empty, is used to restrict the values returned by list_files, list_file_versions, or list_multipart_uploads to only the items whose names begin with the given prefix.

Note: If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the account_allowed_prefix property being non-empty), then this property will automatically be set to that prefix if it is empty when one of the aforementioned methods is called.

File Hierarchy Traversal

By using the delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With delimiter set to /, we can set prefix to successively "deeper" values before calling list_files or list_file_versions for the following effect:

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

The array indices start at 0 and end at query_param_count - 1.

query_param_name Property

The name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

The value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

range Property

The range of bytes to request.

Syntax

def get_range() -> str: ...
def set_range(value: str) -> None: ...

range = property(get_range, set_range)

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a download_file or download_file_by_id request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the start_byte property is greater than zero when one of the aforementioned methods is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by start_byte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

start_byte Property

The byte offset from which to resume the upload or download.

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

Default Value

0

Remarks

This property specifies the byte offset from which to resume an automatic multipart upload initiated by upload_file, or a download initiated by download_file or download_file_by_id. Refer to those methods' documentation for more information about resuming uploads and downloads.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

version_marker Property

A marker indicating what page of file versions to return next.

Syntax

def get_version_marker() -> str: ...
def set_version_marker(value: str) -> None: ...

version_marker = property(get_version_marker, set_version_marker)

Default Value

""

Remarks

This property will be populated when list_file_versions is called if the results are paged and there are more pages. To list all file versions, continue to call list_file_versions until this property returns empty string.

Refer to list_file_versions for more information.

abort_multipart_upload Method

Aborts a multipart upload.

Syntax

def abort_multipart_upload(multipart_file_id: str) -> None: ...

Remarks

This method aborts the multipart upload of the file specified by MultipartFileId, and invalidates the given Id.

When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

add_metadata Method

Adds a metadata item to the Metadata properties.

Syntax

def add_metadata(name: str, value: str) -> None: ...

Remarks

This method adds a metadata item with the given Name and Value to the Metadata* properties. Name may be up to 50 characters in length, and must consist solely of letters, numbers, hyphens (-), and underscores (_). The server stores all metadata item names in lowercase.

A metadata item's name cannot start with b2- unless said name is one those explicitly defined by the Backblaze B2 API documentation. Keep in mind that the value of such a metadata item must comply with the format specified by the Backblaze B2 API documentation as well, otherwise the server will reject it.

Note that there is a limit of 10 metadata items per bucket and per file; the class does not enforce this limit, but the server will return an error if it is exceeded. For files specifically, any value set using the ClientModifiedTime configuration setting will count towards this limit; refer that setting's documentation for more information.

add_query_param Method

Adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

Remarks

This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

authorize Method

Authenticates the class with the server using the current application key and Id.

Syntax

def authorize() -> None: ...

Remarks

This method authenticates the class with the server using the values held by application_key and application_key_id. A successful call to this method will clear and repopulate the following:

• Account* properties
• APIURL configuration setting
• DownloadURL configuration setting
• FragmentSize configuration setting (if necessary; refer to its documentation for more information)
• SimpleUploadLimit configuration setting (if necessary; refer to its documentation for more information)

The class must authenticate with the server before any other requests can be attempted; the class will call it automatically if necessary. As part of the authentication process, the server returns an authorization token which must be used to authorize all further requests; this token is valid for up to 24 hours. When it expires, this method must be called again.

complete_multipart_upload Method

Completes a multipart upload by assembling the previously uploaded parts.

Syntax

def complete_multipart_upload(multipart_file_id: str) -> None: ...

Remarks

This method completes the multipart upload of the file specified by MultipartFileId. The server will assemble all of the parts that have been uploaded into a single file. (Note: The assembled file keeps MultipartFileId as its Id.)

Note that this method automatically calls list_parts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts* properties, nor does it cause the on_part_list event to fire.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

copy_file Method

Copies a file.

Syntax

def copy_file(src_file_id: str, dest_bucket_id: str, dest_file_name: str) -> str: ...

Remarks

This method copies the file version specified by SrcFileId to the bucket specified by DestBucketId with the name DestFileName. The Id of the newly-created file is returned. If DestBucketId is empty, the source file's bucket is used as the destination bucket.

DestFileName is subject to the same restrictions described in the upload_file method's documentation; refer to it for more information. If a file named DestFileName already exists in the destination bucket, a new version of it is created.

If the SendMetadataOnCopy configuration setting is enabled, and the content_type property, the Metadata* properties, and/or the ClientModifiedTime configuration setting are non-empty, then their values will be applied to the destination file. Otherwise, the server will copy the source file's content type and metadata to the destination file.

Finally, note that this method can only be used to copy files up to 5GB in size (or, if range is non-empty, a range of up to 5GB of data from a larger file). To copy more than 5GB of data, start a new multipart upload with start_multipart_upload, and then use the copy_part method to copy the desired data in parts.

The currently-authenticated application key must have the writeFiles and (if the source file's bucket kind is allPrivate) readFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

copy_part Method

Copies the specified file as part of a multipart upload.

Syntax

def copy_part(src_file_id: str, multipart_file_id: str, part_number: int) -> None: ...

Remarks

This method copies the file version specified by SrcFileId to a new part in the multipart upload of the file specified by MultipartFileId. The part's number is specified by PartNumber; it must be a value in the range 1 to 10000, inclusive. If the specified multipart upload already has a part with the given PartNumber, it is replaced with the one created by this request.

All parts must be between 5MB and 5GB in size (except for the last part, which can be as small as 1 byte). The range property can optionally be set before calling this method to copy only a specific range of data from the specified source file.

The currently-authenticated application key must have the writeFiles and (if the source file's bucket kind is allPrivate) readFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

create_app_key Method

Creates a new application key.

Syntax

def create_app_key(key_name: str, capabilities: str, allowed_bucket_id: str, allowed_prefix: str, validity_duration: int) -> str: ...

Remarks

This method creates a new application key named KeyName with the specified Capabilities. If successful, this method returns a string containing the newly-created application key's Id, followed by the key itself, separated by a newline (\n) character; for example:

[application_key_id]
[application_key]

The string passed for Capabilities must be formatted as a comma-separated list of one or more of the following:

To restrict the new application key to a specific bucket, pass the bucket's Id for AllowedBucketId. To further restrict it to files with a specific prefix within that bucket, pass said prefix for AllowedPrefix. It is not possible to apply a prefix restriction without a bucket restriction.

The ValidityDuration parameter specifies how many seconds the new application key will be valid for. The maximum valid value is 86400000 (1000 days); values less than 1 will cause the application key to remain valid indefinitely.

The currently-authenticated application key must have the writeKeys capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

create_bucket Method

Creates a new bucket.

Syntax

def create_bucket(bucket_name: str, kind: str) -> str: ...

Remarks

This method creates a new bucket named BucketName of the specified Kind. Valid values for Kind are allPrivate (default if empty) and allPublic. Each account may have up to 100 buckets.

The value passed for BucketName must comply with the following restrictions:

• Must be between 6 and 50 characters long (inclusive).
• Must consist solely of letters, digits, and hyphens (-).
• Cannot start with the string b2-.
• Must be globally unique (i.e., no two accounts may have a bucket with the same name) when compared case-insensitively.

If any items are present in the Metadata* properties, they will also be included in the request and applied to the newly-created bucket. Keep in mind that the server enforces a limit of 10 metadata items per bucket.

The currently-authenticated application key must have the writeBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

delete_app_key Method

Deletes an application key.

Syntax

def delete_app_key(key_id: str) -> None: ...

Remarks

This method deletes the application key specified by KeyId.

The currently-authenticated application key must have the deleteKeys capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

delete_bucket Method

Deletes a bucket.

Syntax

def delete_bucket(bucket_id: str) -> None: ...

Remarks

This method deletes the bucket specified by BucketId. A bucket must be completely empty to be deleted.

Note that bucket names are global, and it may not be possible to recreate a deleted bucket if its name is taken by another user in the meantime.

The currently-authenticated application key must have the deleteBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

delete_file Method

Deletes all versions of a file.

Syntax

def delete_file(bucket_id: str, file_name: str) -> None: ...

Remarks

This method deletes all versions of the file named FileName from the bucket specified by BucketId. If the latest "version" of the specified file is an incomplete multipart upload, the multipart upload is aborted.

The currently-authenticated application key must have the listFiles and deleteFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

Note: This method is offered as a convenience, as the Backblaze B2 REST API does not technically provide a way to delete all versions of a file using a single request. When this method is called, the class uses list_file_versions to obtain a list of all versions of the specified file, and then uses delete_file_version to delete each one, in order from oldest to newest. If any one request made during this process fails, this method will fail immediately. This process does not alter the File* or file_marker properties, nor does it cause the on_file_list event to fire.

delete_file_version Method

Deletes a file version.

Syntax

def delete_file_version(file_id: str) -> None: ...

Remarks

This method deletes the file version specified by FileId, regardless of whether said version is an actual file or a hide marker

If the most recent version of a file is deleted, and older versions of the file exist, then the most recent older version will become the "current" version. If said version is a hide marker, then the file will become "hidden"; refer to hide_file for more information.

The currently-authenticated application key must have the deleteFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

download_file Method

Downloads a file by name.

Syntax

def download_file(bucket_name: str, file_name: str) -> None: ...

Remarks

This method downloads the latest version of the file named FileName from the bucket named BucketName. The range property can optionally be set before calling this method to download a specific range of data from the file.

This method can be used to download files that are owned by other accounts, so long as an appropriate download authorization token and download URL are supplied using the DownloadAuthToken and DownloadURL configuration settings; refer to their documentation for more information.

If local_file is set, the file data will be saved to the specified location; otherwise, the file data will be held by file_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: b2.LocalFile = "../MyData.zip"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; b2.LocalFile = downloadFile; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file b2.StartByte = new FileInfo(downloadFile).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. b2.LocalFile = "../MyData.zip"; b2.EncryptionPassword = "password"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded temp file b2.StartByte = new FileInfo(b2.Config("DownloadTempFile")).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

The currently-authenticated application key must have the readFiles capability (unless the bucket is public) to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

download_file_by_id Method

Downloads a file by Id.

Syntax

def download_file_by_id(file_id: str) -> None: ...

Remarks

This method downloads the file version specified by FileId. The range property can optionally be set before calling this method to download a specific range of data from the file.

If local_file is set, the file data will be saved to the specified location; otherwise, the file data will be held by file_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: b2.LocalFile = "../MyData.zip"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; b2.LocalFile = downloadFile; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file b2.StartByte = new FileInfo(downloadFile).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. b2.LocalFile = "../MyData.zip"; b2.EncryptionPassword = "password"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded temp file b2.StartByte = new FileInfo(b2.Config("DownloadTempFile")).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

The currently-authenticated application key must have the readFiles capability (unless the bucket is public) to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

get_bucket_info Method

Gets a bucket's information and metadata.

Syntax

def get_bucket_info(bucket_id: str) -> None: ...

Remarks

This method gets information and metadata for the bucket specified by BucketId.

Calling this method will fire the on_bucket_list and on_metadata_list events, and will re-populate the Bucket* and Metadata* properties.

The currently-authenticated application key must have the listBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

get_download_auth_token Method

Create a download authorization token for one or more files in a bucket.

Syntax

def get_download_auth_token(allowed_bucket_id: str, allowed_prefix: str, validity_duration: int) -> str: ...

Remarks

This method creates and returns a download authorization token for the files in the bucket specified by AllowedBucketId whose names start with AllowedPrefix. The newly-created token will remain valid for the number of seconds specified by ValidityDuration, which must be a value in the range 1 to 604800 (1 week), inclusive.

Download authorization tokens created using this method can be used by anybody to download an applicable file by name; they cannot be used to download a file by Id. Refer to the download_file method for more information.

The currently-authenticated application key must have the shareFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

get_file_info Method

Gets a file's information and metadata.

Syntax

def get_file_info(file_id: str) -> None: ...

Remarks

This method gets information and metadata for the file version specified by FileId (which must be a real file version, or a hide marker, not a multipart upload).

Calling this method will fire the on_file_list and on_metadata_list events, and will re-populate the File* and Metadata* properties.

The currently-authenticated application key must have the readFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

hide_file Method

Hides a file.

Syntax

def hide_file(bucket_id: str, file_name: str) -> str: ...

Remarks

This method hides the file named FileName in the bucket specified by BucketId by creating a special version of the file called a hide marker.

If the latest version of a file is a hide marker, then the file will not appear in the results returned by list_files, nor can it be downloaded by name using download_file. However:

• Any version of the file (excluding hide markers) can still be downloaded directly using download_file_by_id.
• All versions of the file can still be deleted, either all at once using delete_file, or individually using delete_file_version.
• All versions of the file will still appear in the results returned by list_file_versions, and can still be queried individually using get_file_info.

To unhide a file, simply delete the hide marker using delete_file_version.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_app_keys Method

Lists the account's application keys.

Syntax

def list_app_keys() -> None: ...

Remarks

This method lists the application keys associated with the account. Note that the account's master application key is not included in the results.

Calling this method will fire the on_app_key_list event once for each application key, and will also populate the AppKey* properties.

If there are still more application keys available to list when this method returns, the app_key_marker property will be populated. Continue to call this method until app_key_marker is empty to accumulate all pages of results in the AppKey* properties.

The MaxAppKeyResults configuration setting can be used to control the maximum number of results returned each time this method is called.

The currently-authenticated application key must have the listKeys capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

list_buckets Method

Lists all buckets in the account.

Syntax

def list_buckets() -> None: ...

Remarks

This method lists all buckets in the account.

Calling this method will fire the on_bucket_list event once for each bucket, and will also populate the Bucket* properties. If the ListWithMetadata configuration setting is enabled, the on_metadata_list event will also be fired, once for each metadata item associated with each bucket.

If the currently-authenticated application key is restricted to a specific bucket (indicated by the account_allowed_bucket_id property being non-empty), the results will only include information for that bucket.

The currently-authenticated application key must have the listBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

list_files Method

Lists the files in a bucket.

Syntax

def list_files(bucket_id: str) -> None: ...

Remarks

This method lists the files in the bucket specified by BucketId.

Before calling this method, the prefix property may be set in order to restrict the results to only the files whose names begin with the a given string. The delimiter property can also be used to further tune the results returned. The MaxResults configuration setting may also be used to limit the number of results returned.

If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the account_allowed_prefix property being non-empty), then the prefix property will automatically be set to that prefix if it is empty when this method is called.

Calling this method will fire the on_file_list event once for each file, and will also populate the File* properties. If the ListWithMetadata configuration setting is enabled, the on_metadata_list event will also be fired, once for each metadata item associated with each file.

If there are still more files available to list when this method returns, the file_marker property will be populated. Continue to call this method until file_marker is empty to accumulate all pages of results in the File* properties.

The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

File Hierarchy Traversal

By using the delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With delimiter set to /, we can set prefix to successively "deeper" values before calling list_files or list_file_versions for the following effect:

list_file_versions Method

Lists the file versions in a bucket.

Syntax

def list_file_versions(bucket_id: str) -> None: ...

Remarks

This method lists the file versions in the bucket specified by BucketId.

Before calling this method, the prefix property may be set in order to restrict the results to only the file versions whose names begin with the a given string. The delimiter property can also be used to further tune the results returned. The MaxResults configuration setting may also be used to limit the number of results returned.

If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the account_allowed_prefix property being non-empty), then the prefix property will automatically be set to that prefix if it is empty when this method is called.

Calling this method will fire the on_file_list event once for each file version, and will also populate the File* properties. If the ListWithMetadata configuration setting is enabled, the on_metadata_list event will also be fired, once for each metadata item associated with each file version.

If there are still more files versions available to list when this method returns, the version_marker property will be populated. Continue to call this method until version_marker is empty to accumulate all pages of results in the File* properties.

The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

File Hierarchy Traversal

By using the delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With delimiter set to /, we can set prefix to successively "deeper" values before calling list_files or list_file_versions for the following effect:

list_multipart_uploads Method

Lists the in-progress multipart uploads in a bucket.

Syntax

def list_multipart_uploads(bucket_id: str) -> None: ...

Remarks

This method lists the in-progress multipart uploads in the bucket specified by BucketId.

Before calling this method, the prefix property may be set in order to restrict the results to only the multipart uploads whose file names begin with the a given string.

If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the account_allowed_prefix property being non-empty), then the prefix property will automatically be set to that prefix if it is empty when this method is called.

Calling this method will fire the on_file_list event once for each multipart upload, and will also populate the File* properties. If the ListWithMetadata configuration setting is enabled, the on_metadata_list event will also be fired, once for each metadata item associated with each multipart upload.

The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

list_parts Method

Lists a multipart upload's parts.

Syntax

def list_parts(multipart_file_id: str) -> None: ...

Remarks

This method lists the parts that have been created for the multipart file upload specified by MultipartFileId.

Calling this method will fire the on_part_list event once for each part, and will also populate the Part* properties.

If there are still more parts available to list when this method returns, the part_marker property will be populated. Continue to call this method until part_marker is empty to accumulate all pages of results in the Part* properties.

The MaxPartResults configuration setting can be used to control the maximum number of results returned each time this method is called.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

reset Method

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

send_custom_request Method

Sends a custom request to the Backblaze B2 API.

Syntax

def send_custom_request(http_method: str, operation: str, request_body: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the Backblaze B2 API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST

The value passed for Operation must be one of the API operations described in the Backblaze B2 REST API documentation (e.g., b2_list_buckets).

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified Operation is appended to the base Backblaze B2 API URL (refer to the APIURL configuration setting for more information).
   • All query parameters in the QueryParam* properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL built in step 1, the header information built from account_auth_token and other_headers, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeader* properties, and the response body in the specified local_file, or resource_data (using the same logic as download_file).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

start_multipart_upload Method

Starts a new multipart upload.

Syntax

def start_multipart_upload(bucket_id: str, file_name: str) -> str: ...

Remarks

This method starts a new multipart upload for a file named FileName in the bucket specified by BucketId, and returns the Id of the newly-created multipart upload. This Id can then be used to call the following methods:

• upload_part
• copy_part
• list_parts
• complete_multipart_upload
• abort_multipart_upload

FileName is subject to the same restrictions described in the upload_file method's documentation; refer to it for more information. If a file named FileName already exists in the destination bucket, a new version of it is created.

The following information is also included in the request, and will be applied to the final file when the multipart upload is completed with complete_multipart_upload:

• All metadata items present in the Metadata* properties. Keep in mind that the server enforces a limit of 10 metadata items per file.
• If the ClientModifiedTime configuration setting is non-empty: an additional metadata item with its value (which does count towards the 10 item limit).
• The value of the content_type property.

Multipart uploads never expire, they must be explicitly completed or aborted using complete_multipart_upload or abort_multipart_upload. The list_multipart_uploads method can be used to retrieve a list of current multipart uploads.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

update_bucket Method

Updates a bucket's kind and/or metadata.

Syntax

def update_bucket(bucket_id: str, new_kind: str, new_metadata: bool) -> None: ...

Remarks

This method updates the kind and/or metadata of the bucket specified by BucketId.

If NewKind is non-empty, it must be allPrivate or allPublic. If NewKind is empty, the bucket's kind remains unchanged.

If NewMetadata is True, the bucket's current metadata items are replaced with those in the Metadata* properties (or cleared, if said properties are empty). If NewMetadata is False, the bucket's current metadata remains unchanged. Keep in mind that the server enforces a limit of 10 metadata items per bucket.

If NewKind is empty and NewMetadata is false, this method does nothing.

The IfRevision setting can optionally be set before calling this method to ensure that the requested changes are only made if the bucket's current revision matches the given one.

The currently-authenticated application key must have the writeBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

upload_file Method

Uploads a file.

Syntax

def upload_file(bucket_id: str, file_name: str) -> str: ...

Remarks

This method uploads a new file named FileName to the bucket specified by BucketId, and returns the Id of the newly-created file.

The value passed for FileName must comply with the following restrictions:

• Cannot contain non-printable or DEL characters (i.e., character codes below 32 or equal to 127, respectively).
• Cannot contain backslashes (\).
• Cannot begin or end with a slash (/), and cannot contain two subsequent slashes (//).
• No segment (i.e., a part between slashes) can be more than 250 bytes long (when UTF-8 encoded).
• The overall string can be no more than 1024 bytes long overall (when UTF-8 encoded).

If a file with the specified FileName already exists in the destination bucket, a new version of it is created.

The following information is also included in the request, and will be applied to the newly-created file:

• All metadata items present in the Metadata* properties. Keep in mind that the server enforces a limit of 10 metadata items per file.
• If the ClientModifiedTime configuration setting is non-empty: an additional metadata item with its value (which does count towards the 10 item limit).
• The value of the content_type property.

If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in file_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

Automatic Multipart Uploads

If more than SimpleUploadLimit bytes of data are provided, the class will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the class automatically makes calls to start_multipart_upload, upload_part, and complete_multipart_upload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the start_byte property. The on_fragment_complete event will fire after each part is uploaded.

If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and start_byte contain the same values as they did when the upload was interrupted.

When an automatic multipart upload completes successfully, ResumableUploadState is cleared and start_byte is reset to 0.

upload_part Method

Uploads a multipart upload part.

Syntax

def upload_part(multipart_file_id: str, part_number: int) -> None: ...

Remarks

This method uploads a new part for the multipart file upload specified by MultipartFileId. The part's number is specified by PartNumber; it must be a value in the range 1 to 10000, inclusive. If the specified multipart upload already has a part with the given PartNumber, it is replaced with the one created by this request.

The data to upload is taken from either local_file or file_data (whichever data is found in first, when checked in that order). All parts must be between 5MB and 5GB in size (except for the last part, which can be as small as 1 byte).

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.

on_app_key_list Event

Fires once for each application key returned when listing application keys.

Syntax

class BackblazeB2AppKeyListEventParams(object):
  @property
  def key_id() -> str: ...

  @property
  def key_name() -> str: ...

  @property
  def capabilities() -> str: ...

  @property
  def allowed_bucket_id() -> str: ...

  @property
  def allowed_prefix() -> str: ...

  @property
  def expiration_time() -> int: ...

# In class BackblazeB2:
@property
def on_app_key_list() -> Callable[[BackblazeB2AppKeyListEventParams], None]: ...
@on_app_key_list.setter
def on_app_key_list(event_hook: Callable[[BackblazeB2AppKeyListEventParams], None]) -> None: ...

Remarks

This event fires once for each application key returned when list_app_keys is called.

KeyId reflects the unique Id of the application key.

KeyName reflects the name that was given to the application key when it was created.

Capabilities reflects the capabilities that the application key has. It is formatted as a comma-separated list of one or more of the following:

AllowedBucketId reflects the Id of the bucket that the application key is restricted to. It will be empty if the application key is not restricted to any specific bucket.

AllowedPrefix reflects the file name prefix that the application key is restricted to. It will be empty if the application key is not restricted to a specific file name prefix.

ExpirationTime reflects the expiration time of the application key, in milliseconds relative to the Unix epoch. It will be -1 if the application key does not expire.

on_bucket_list Event

Fires once for each bucket returned when listing buckets.

Syntax

class BackblazeB2BucketListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def kind() -> str: ...

  @property
  def revision() -> int: ...

# In class BackblazeB2:
@property
def on_bucket_list() -> Callable[[BackblazeB2BucketListEventParams], None]: ...
@on_bucket_list.setter
def on_bucket_list(event_hook: Callable[[BackblazeB2BucketListEventParams], None]) -> None: ...

Remarks

This event fires once for each bucket returned when list_buckets is called.

Id reflects the unique Id of the bucket.

Name reflects the name of the bucket.

Kind reflects the bucket's kind. Possible values are allPublic, allPrivate, or snapshot.

Revision reflects the bucket's revision number. A bucket's revision number is updated every time the bucket is modified.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class BackblazeB2EndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class BackblazeB2:
@property
def on_end_transfer() -> Callable[[BackblazeB2EndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[BackblazeB2EndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Information about errors during data delivery.

Syntax

class BackblazeB2ErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class BackblazeB2:
@property
def on_error() -> Callable[[BackblazeB2ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[BackblazeB2ErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_file_list Event

Fires once for each file returned when listing files.

Syntax

class BackblazeB2FileListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def bucket_id() -> str: ...

  @property
  def size() -> int: ...

  @property
  def content_type() -> str: ...

  @property
  def created_time() -> int: ...

  @property
  def modified_time() -> int: ...

  @property
  def kind() -> str: ...

  @property
  def sha1_hash() -> str: ...

# In class BackblazeB2:
@property
def on_file_list() -> Callable[[BackblazeB2FileListEventParams], None]: ...
@on_file_list.setter
def on_file_list(event_hook: Callable[[BackblazeB2FileListEventParams], None]) -> None: ...

Remarks

This event fires once for each file returned when list_files, list_file_versions, or list_multipart_uploads is called.

Id reflects the Id of the file. Always empty when Kind is folder.

Name reflects the name of the file.

BucketId reflects the Id of the bucket that the file is in.

Size reflects the size of the file, in bytes. Always 0 when Kind is folder, hide, or start.

ContentType reflects the content type of the file. Always application/x-bz-hide-marker when Kind is hide; and empty when Kind is folder.

CreatedTime reflects the file's creation time, in milliseconds relative to the Unix epoch. Always 0 when Kind is folder.

ModifiedTime reflects the file's last modified time, in milliseconds relative to the Unix epoch. (Note that this parameter will only be populated if a src_last_modified_millis metadata item is included for the file, and if that metadata item's value can be parsed as a 64-bit integer; otherwise, it will be -1. Refer to the ClientModifiedTime configuration setting for more information.)

Kind reflects the file's kind. Possible values are:

SHA1Hash reflects a hex-encoded SHA1 hash of the file's contents, or empty string if such a hash is not available. Always empty when Kind is folder or hide.

on_fragment_complete Event

Fires after each part in an automatic multipart upload is complete.

Syntax

class BackblazeB2FragmentCompleteEventParams(object):
  @property
  def fragment_number() -> int: ...

  @property
  def fragment_count() -> int: ...

  @property
  def interrupt() -> bool: ...
  @interrupt.setter
  def interrupt(value) -> None: ...

# In class BackblazeB2:
@property
def on_fragment_complete() -> Callable[[BackblazeB2FragmentCompleteEventParams], None]: ...
@on_fragment_complete.setter
def on_fragment_complete(event_hook: Callable[[BackblazeB2FragmentCompleteEventParams], None]) -> None: ...

Remarks

If, when upload_file is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part that has completed. This value starts at 1.

FragmentCount is the total number of parts that will be uploaded.

Interrupt can be set to True to interrupt the upload. The upload may be resumed later.

Refer to upload_file for more information.

on_header Event

This event is fired every time a header line comes in.

Syntax

class BackblazeB2HeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class BackblazeB2:
@property
def on_header() -> Callable[[BackblazeB2HeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[BackblazeB2HeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

This event fires once for each log message.

Syntax

class BackblazeB2LogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class BackblazeB2:
@property
def on_log() -> Callable[[BackblazeB2LogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[BackblazeB2LogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_metadata_list Event

Fires once for each metadata item returned when bucket or file information and metadata is retrieved.

Syntax

class BackblazeB2MetadataListEventParams(object):
  @property
  def bucket_id() -> str: ...

  @property
  def file_id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

# In class BackblazeB2:
@property
def on_metadata_list() -> Callable[[BackblazeB2MetadataListEventParams], None]: ...
@on_metadata_list.setter
def on_metadata_list(event_hook: Callable[[BackblazeB2MetadataListEventParams], None]) -> None: ...

Remarks

This event fires once for each metadata item returned when get_bucket_info or get_file_info is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual bucket or file is returned when list_buckets, list_files, list_file_versions, or list_multipart_uploads is called.

BucketId reflects the Id of the bucket that the file is in (if FileId is non-empty), or that the metadata item is associated with (if FileId is empty).

FileId, if non-empty, reflects the Id of the file that the metadata item is associated with.

Name reflects the name of the metadata item.

Value reflects the value of the metadata item.

on_part_list Event

Fires once for each part returned when listing a multipart upload's parts.

Syntax

class BackblazeB2PartListEventParams(object):
  @property
  def part_number() -> int: ...

  @property
  def multipart_file_id() -> str: ...

  @property
  def size() -> int: ...

  @property
  def created_time() -> int: ...

  @property
  def sha1_hash() -> str: ...

# In class BackblazeB2:
@property
def on_part_list() -> Callable[[BackblazeB2PartListEventParams], None]: ...
@on_part_list.setter
def on_part_list(event_hook: Callable[[BackblazeB2PartListEventParams], None]) -> None: ...

Remarks

This event fires once for each part returned when list_parts is called.

PartNumber reflects the part's number.

MultipartFileId reflects the Id of the multipart file upload that the part is a part of.

Size reflects the size of the part, in bytes.

CreatedTime reflects the part's creation time (i.e., upload time), in milliseconds relative to the Unix epoch.

SHA1Hash reflects a hex-encoded SHA1 hash of the part's contents.

on_progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

class BackblazeB2ProgressEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def total_bytes() -> int: ...

  @property
  def percent_done() -> int: ...

# In class BackblazeB2:
@property
def on_progress() -> Callable[[BackblazeB2ProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[BackblazeB2ProgressEventParams], None]) -> None: ...

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class BackblazeB2SSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class BackblazeB2:
@property
def on_ssl_server_authentication() -> Callable[[BackblazeB2SSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[BackblazeB2SSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class BackblazeB2SSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class BackblazeB2:
@property
def on_ssl_status() -> Callable[[BackblazeB2SSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[BackblazeB2SSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

on_start_transfer Event

This event fires when a document starts transferring (after the headers).

Syntax

class BackblazeB2StartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class BackblazeB2:
@property
def on_start_transfer() -> Callable[[BackblazeB2StartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[BackblazeB2StartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer Event

This event is fired while a document transfers (delivers document).

Syntax

class BackblazeB2TransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class BackblazeB2:
@property
def on_transfer() -> Callable[[BackblazeB2TransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[BackblazeB2TransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

BackblazeB2 Config Settings

BackblazeB2 Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

BackblazeB2 Errors

Common Errors

BackblazeB2 Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors