BackblazeB2 Class
Properties Methods Events Configuration Settings Errors
The BackblazeB2 class offers an easy to use interface for Backblaze's B2 Cloud Storage service.
Syntax
class ipworkscloud.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.
| account_id | The Id of the account. |
| account_allowed_bucket_id | The Id of the bucket that the application key is restricted to. |
| account_allowed_bucket_name | The name of the bucket that the application key is restricted to. |
| account_allowed_prefix | The file name prefix that the application key is restricted to. |
| account_auth_token | The authorization token that will be used to authorize requests. |
| account_capabilities | The capabilities that the application key has. |
| account_min_part_size | The minimum allowed multipart upload part size. |
| account_rec_part_size | The recommended multipart upload part size. |
| app_key_marker | A marker indicating what page of application keys to return next. |
| app_key_count | The number of records in the AppKey arrays. |
| app_key_allowed_bucket_id | The Id of the bucket that the application key is restricted to. |
| app_key_allowed_prefix | The file name prefix that the application key is restricted to. |
| app_key_capabilities | The capabilities that the application key has. |
| app_key_expiration_time | The application key's expiration time. |
| app_key_id | The Id of the application key. |
| app_key_name | The name of the application key. |
| application_key | The application key to use for authentication. |
| application_key_id | The application key Id to use for authentication. |
| bucket_count | The number of records in the Bucket arrays. |
| bucket_id | The Id of the bucket. |
| bucket_kind | The kind of bucket. |
| bucket_name | The name of the bucket. |
| bucket_revision | The revision number of the bucket. |
| content_type | The content type to send for a file. |
| delimiter | The delimiter string to use when listing files. |
| encryption_algorithm | The encryption algorithm. |
| encryption_password | The encryption password. |
| file_data | The data that was downloaded, or that should be uploaded. |
| file_marker | A marker indicating what page of files to return next. |
| file_count | The number of records in the File arrays. |
| file_bucket_id | The Id of the bucket that the file is in. |
| file_content_type | The content type of the file. |
| file_created_time | The file's creation time. |
| file_id | The Id of the file. |
| file_kind | The kind of file. |
| file_md5_hash | An MD5 hash of the file's contents. |
| file_modified_time | The file's last modified time. |
| file_name | The name of the file. |
| file_sha1_hash | A SHA1 hash of the file's contents. |
| file_size | The file's size. |
| firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
| firewall_type | This property determines the type of firewall to connect through. |
| firewall_host | This property contains the name or IP address of firewall (optional). |
| firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
| firewall_port | This property contains the TCP port for the firewall Host . |
| firewall_user | This property contains a user name if authentication is to be used connecting through a firewall. |
| idle | The current status of the class. |
| local_file | The location of the local file. |
| local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| metadata_count | The number of records in the Metadata arrays. |
| metadata_name | The name of the metadata item. |
| metadata_value | The value of the metadata item. |
| other_headers | Other headers as determined by the user (optional). |
| overwrite | Determines if local files are overwritten. |
| parsed_header_count | The number of records in the ParsedHeader arrays. |
| parsed_header_field | This property contains the name of the HTTP header (same case as it is delivered). |
| parsed_header_value | This property contains the header contents. |
| part_marker | A marker indicating what page of parts to return next. |
| part_count | The number of records in the Part arrays. |
| part_created_time | The part's creation time. |
| part_md5_hash | An MD5 hash of the part's contents. |
| part_number | The number of the part. |
| part_sha1_hash | A SHA1 hash of the part's contents. |
| part_size | The part's size. |
| prefix | A prefix used to restrict the results returned when listing files. |
| proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
| proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
| proxy_password | This property contains a password if authentication is to be used for the proxy. |
| proxy_port | This property contains the TCP port for the proxy Server (default 80). |
| proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| proxy_ssl | This property determines when to use SSL for the connection to the proxy. |
| proxy_user | This property contains a user name, if authentication is to be used for the proxy. |
| query_param_count | The number of records in the QueryParam arrays. |
| query_param_name | The name of the query parameter. |
| query_param_value | The value of the query parameter. |
| range | The range of bytes to request. |
| ssl_accept_server_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_store | The name of the certificate store for the client certificate. |
| ssl_cert_store_password | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| ssl_cert_store_type | The type of certificate store for this certificate. |
| ssl_cert_subject | The subject of the certificate used for client authentication. |
| ssl_server_cert_encoded | The certificate (PEM/base64 encoded). |
| start_byte | The byte offset from which to resume the upload or download. |
| timeout | A timeout for the class. |
| version_marker | A marker indicating what page of file versions to return next. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| abort_multipart_upload | Aborts a multipart upload. |
| add_metadata | Adds a metadata item to the Metadata properties. |
| add_query_param | Adds a query parameter to the QueryParams properties. |
| authorize | Authenticates the class with the server using the current application key and Id. |
| complete_multipart_upload | Completes a multipart upload by assembling the previously uploaded parts. |
| config | Sets or retrieves a configuration setting. |
| copy_file | Copies a file. |
| copy_part | Copies the specified file as part of a multipart upload. |
| create_app_key | Creates a new application key. |
| create_bucket | Creates a new bucket. |
| delete_app_key | Deletes an application key. |
| delete_bucket | Deletes a bucket. |
| delete_file | Deletes all versions of a file. |
| delete_file_version | Deletes a file version. |
| download_file | Downloads a file by name. |
| download_file_by_id | Downloads a file by Id. |
| get_bucket_info | Gets a bucket's information and metadata. |
| get_download_auth_token | Create a download authorization token for one or more files in a bucket. |
| get_file_info | Gets a file's information and metadata. |
| hide_file | Hides a file. |
| interrupt | Interrupt the current method. |
| list_app_keys | Lists the account's application keys. |
| list_buckets | Lists all buckets in the account. |
| list_files | Lists the files in a bucket. |
| list_file_versions | Lists the file versions in a bucket. |
| list_multipart_uploads | Lists the in-progress multipart uploads in a bucket. |
| list_parts | Lists a multipart upload's parts. |
| reset | Resets the class to its initial state. |
| send_custom_request | Sends a custom request to the Backblaze B2 API. |
| start_multipart_upload | Starts a new multipart upload. |
| update_bucket | Updates a bucket's kind and/or metadata. |
| upload_file | Uploads a file. |
| upload_part | Uploads a multipart upload part. |
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.
| on_app_key_list | Fires once for each application key returned when listing application keys. |
| on_bucket_list | Fires once for each bucket returned when listing buckets. |
| on_end_transfer | Fired when a document finishes transferring. |
| on_error | Information about errors during data delivery. |
| on_file_list | Fires once for each file returned when listing files. |
| on_fragment_complete | Fires after each part in an automatic multipart upload is complete. |
| on_header | Fired every time a header line comes in. |
| on_log | Fires once for each log message. |
| on_metadata_list | Fires once for each metadata item returned when bucket or file information and metadata is retrieved. |
| on_part_list | Fires once for each part returned when listing a multipart upload's parts. |
| on_progress | Fires during an upload or download to indicate transfer progress. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
| on_start_transfer | Fired when a document starts transferring (after the headers). |
| on_transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
| APIURL | The base URL used for all except download and upload requests. |
| APIVersion | The Backblaze B2 REST API version being used by the class. |
| ClientModifiedTime | The client-side last modified time. |
| DownloadAuthToken | The download authorization token to use. |
| DownloadTempFile | The temporary file used when downloading encrypted data. |
| DownloadURL | The base URL used for download requests. |
| EncryptionIV | The initialization vector to be used for encryption/decryption. |
| EncryptionKey | The key to use during encryption/decryption. |
| FragmentSize | The part size to use when uploading a new file. |
| IfRevision | The revision number that the bucket must currently have in order for a request to succeed. |
| ListWithMetadata | Whether to include metadata items when listing buckets, files, etc. |
| MaxAppKeyResults | The maximum number of results to return when listing application keys. |
| MaxPartResults | The maximum number of results to return when listing parts. |
| MaxResults | The maximum number of results to return when listing files or file versions. |
| ProgressAbsolute | Whether the class should track transfer progress absolutely. |
| ProgressStep | How often the progress event should be fired, in terms of percentage. |
| RawRequest | Returns the data that was sent to the server. |
| RawResponse | Returns the data that was received from the server. |
| ResumableUploadState | Tracks upload state information during an automatic multipart upload. |
| SendMetadataOnCopy | Whether to send metadata items when copying files. |
| SimpleUploadLimit | The maximum data size the class should attempt to upload directly when creating a file. |
| TempPath | The path to the directory where temporary files are created. |
| XChildCount | The number of child elements of the current element. |
| XChildName[i] | The name of the child element. |
| XChildXText[i] | The inner text of the child element. |
| XElement | The name of the current element. |
| XParent | The parent of the current element. |
| XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
| XSubTree | A snapshot of the current element in the document. |
| XText | The text of the current element. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the class will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the class. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |