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 property 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 the 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 Transmission Control Protocol (TCP) port for the firewall Host . |
firewall_user | This property contains a username if authentication is to be used when connecting through a firewall. |
idle | This property specifies the current status of the class. |
local_file | The location of the local file. |
local_host | This property includes 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 | This property includes 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 (this is the 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 Transmission Control Protocol (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 a Secure Sockets Layer (SSL) for the connection to the proxy. |
proxy_user | This property contains a username 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_effective_date | This is the date on which this certificate becomes valid. |
ssl_accept_server_cert_expiration_date | This is the date the certificate expires. |
ssl_accept_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_accept_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_accept_server_cert_issuer | This is the issuer of the certificate. |
ssl_accept_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_accept_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_accept_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_accept_server_cert_public_key | This is the public key of the certificate. |
ssl_accept_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_accept_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_accept_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_accept_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_accept_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_accept_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_accept_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_accept_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_accept_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_accept_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_accept_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_accept_server_cert_version | This property contains the certificate's version number. |
ssl_accept_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_cert_expiration_date | This is the date the certificate expires. |
ssl_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_cert_issuer | This is the issuer of the certificate. |
ssl_cert_private_key | This is the private key of the certificate (if available). |
ssl_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_cert_public_key | This is the public key of the certificate. |
ssl_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | 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 | This is the type of certificate store for this certificate. |
ssl_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_cert_usage | This property contains the text description of UsageFlags . |
ssl_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_cert_version | This property contains the certificate's version number. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_provider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
ssl_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_server_cert_expiration_date | This is the date the certificate expires. |
ssl_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_server_cert_issuer | This is the issuer of the certificate. |
ssl_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_server_cert_public_key | This is the public key of the certificate. |
ssl_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_server_cert_version | This property contains the certificate's version number. |
ssl_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
start_byte | The byte offset from which to resume the upload or download. |
timeout | This property includes the 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 | This method interrupts 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 | This event fires when a document finishes transferring. |
on_error | Fired when information is available 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 | This event is fired every time a header line comes in. |
on_log | This event 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 | Fired when secure connection progress messages are available. |
on_start_transfer | This event fires when a document starts transferring (after the headers). |
on_transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config 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. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and 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. |
StatusCode | The status code of the last response from the server. |
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. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
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 be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
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. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
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. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
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. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
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:
Capability String | Related Methods |
deleteBuckets | delete_bucket |
deleteFiles | delete_file, delete_file_version |
deleteKeys | delete_app_key |
listBuckets | get_bucket_info, list_buckets |
listFiles | delete_file, list_files, list_file_versions, list_multipart_uploads |
listKeys | list_app_keys |
readFiles | copy_file, copy_part, download_file, download_file_by_id, get_file_info |
shareFiles | get_download_auth_token |
writeBuckets | create_bucket, update_bucket |
writeFiles | abort_multipart_upload, complete_multipart_upload, copy_file, copy_part, hide_file, list_parts, start_multipart_upload, upload_file, upload_part |
writeKeys | create_app_key |
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
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:
Capability String | Related Methods |
deleteBuckets | delete_bucket |
deleteFiles | delete_file, delete_file_version |
deleteKeys | delete_app_key |
listBuckets | get_bucket_info, list_buckets |
listFiles | delete_file, list_files, list_file_versions, list_multipart_uploads |
listKeys | list_app_keys |
readFiles | copy_file, copy_part, download_file, download_file_by_id, get_file_info |
shareFiles | get_download_auth_token |
writeBuckets | create_bucket, update_bucket |
writeFiles | abort_multipart_upload, complete_multipart_upload, copy_file, copy_part, hide_file, list_parts, start_multipart_upload, upload_file, upload_part |
writeKeys | create_app_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_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:
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:
prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
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:
Algorithm | Key Size |
0 (eaAES - default) | 256 |
1 (eaBlowfish) | 448 |
2 (eaCAST) | 128 |
3 (eaDES) | 64 |
4 (eaIDEA) | 128 |
5 (eaRC2) | 128 |
6 (eaRC4) | 2048 |
7 (eaTEA) | 128 |
8 (eaTripleDES) | 192 |
9 (eaTwofish) | 256 |
10 (eaRijndael) | 256 |
11 (eaChaCha) | 256 |
12 (eaXSalsa20) | 256 |
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
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:
folder | A "folder" (only applicable when listing files with a delimiter). |
hide | A hide marker file version created by hide_file. |
start | A multipart file upload that has not been completed or abandoned yet. |
upload | An file that has been uploaded (either directly, or via a multipart upload). |
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:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains the name or IP address of the 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 the 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 username if authentication is to be used when 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 username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
idle Property
This property specifies 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 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
This property includes 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
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 multihomed 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:
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:
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:
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:
prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
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 properties 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:
psAutomatic (0) | Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
proxy_user Property
This property contains a username 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 username if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties 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:
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_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_accept_server_cert_effective_date() -> str: ...
ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_accept_server_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_accept_server_cert_expiration_date() -> str: ...
ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_accept_server_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_accept_server_cert_extended_key_usage() -> str: ...
ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_accept_server_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint() -> str: ...
ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_accept_server_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...
ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_accept_server_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...
ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_accept_server_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_accept_server_cert_issuer() -> str: ...
ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_accept_server_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key() -> str: ...
ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.
This property is read-only.
ssl_accept_server_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_accept_server_cert_private_key_available() -> bool: ...
ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_accept_server_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key_container() -> str: ...
ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_accept_server_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_accept_server_cert_public_key() -> str: ...
ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_accept_server_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...
ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_accept_server_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_accept_server_cert_public_key_length() -> int: ...
ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_accept_server_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_accept_server_cert_serial_number() -> str: ...
ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_accept_server_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_accept_server_cert_signature_algorithm() -> str: ...
ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_accept_server_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ...
ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password protected, specify the password in ssl_accept_server_cert_store_password.
ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 certificate store).
ssl_accept_server_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_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ...
ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_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_accept_server_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ...
ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_accept_server_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_accept_server_cert_subject_alt_names() -> str: ...
ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_accept_server_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...
ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...
ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...
ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_accept_server_cert_usage() -> str: ...
ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_accept_server_cert_usage_flags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_accept_server_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_accept_server_cert_usage_flags() -> int: ...
ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_accept_server_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_accept_server_cert_version() -> str: ...
ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_accept_server_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ...
ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_cert_effective_date() -> str: ...
ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_cert_expiration_date() -> str: ...
ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_cert_extended_key_usage() -> str: ...
ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint() -> str: ...
ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha1() -> str: ...
ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha256() -> str: ...
ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_cert_private_key() -> str: ...
ssl_cert_private_key = property(get_ssl_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.
This property is read-only.
ssl_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_cert_private_key_available() -> bool: ...
ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_cert_private_key_container() -> str: ...
ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_cert_public_key() -> str: ...
ssl_cert_public_key = property(get_ssl_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_cert_public_key_algorithm() -> str: ...
ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_cert_public_key_length() -> int: ...
ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_cert_serial_number() -> str: ...
ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_cert_signature_algorithm() -> str: ...
ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_cert_subject_alt_names() -> str: ...
ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_md5() -> str: ...
ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha1() -> str: ...
ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha256() -> str: ...
ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_cert_usage_flags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_cert_usage_flags() -> int: ...
ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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_provider Property
This property specifies the Secure Sockets Layer/Transport Layer Security (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 as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_server_cert_effective_date() -> str: ...
ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_server_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_server_cert_expiration_date() -> str: ...
ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_server_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_server_cert_extended_key_usage() -> str: ...
ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_server_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint() -> str: ...
ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_server_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha1() -> str: ...
ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_server_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha256() -> str: ...
ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_server_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_server_cert_issuer() -> str: ...
ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_server_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_server_cert_private_key() -> str: ...
ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.
This property is read-only.
ssl_server_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_server_cert_private_key_available() -> bool: ...
ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_server_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_server_cert_private_key_container() -> str: ...
ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_server_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_server_cert_public_key() -> str: ...
ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_server_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_server_cert_public_key_algorithm() -> str: ...
ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_server_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_server_cert_public_key_length() -> int: ...
ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_server_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_server_cert_serial_number() -> str: ...
ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_server_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_server_cert_signature_algorithm() -> str: ...
ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_server_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_server_cert_store() -> bytes: ...
ssl_server_cert_store = property(get_ssl_server_cert_store, None)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password protected, specify the password in ssl_server_cert_store_password.
ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 certificate store).
This property is read-only.
ssl_server_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_server_cert_store_password() -> str: ...
ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)
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.
This property is read-only.
ssl_server_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_server_cert_store_type() -> int: ...
ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_server_cert_store and set ssl_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
ssl_server_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_server_cert_subject_alt_names() -> str: ...
ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_server_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_md5() -> str: ...
ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha1() -> str: ...
ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha256() -> str: ...
ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_server_cert_usage() -> str: ...
ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_server_cert_usage_flags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_server_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_server_cert_usage_flags() -> int: ...
ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_server_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_server_cert_version() -> str: ...
ssl_server_cert_version = property(get_ssl_server_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_server_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_server_cert_subject() -> str: ...
ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
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
This property includes the 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.
Note: By default, all timeouts are inactivity timeouts, that is, 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 query_params 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 property
- 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]Important: This is the only time that the application key's key string will be returned, be sure to save it immediately. It is not present in the results returned by the list_app_keys method (this is a security feature enforced by the server).
The string passed for Capabilities must be formatted as a comma-separated list of one or more of the following:
Capability String | Related Methods |
deleteBuckets | delete_bucket |
deleteFiles | delete_file, delete_file_version |
deleteKeys | delete_app_key |
listBuckets | get_bucket_info, list_buckets |
listFiles | delete_file, list_files, list_file_versions, list_multipart_uploads |
listKeys | list_app_keys |
readFiles | copy_file, copy_part, download_file, download_file_by_id, get_file_info |
shareFiles | get_download_auth_token |
writeBuckets | create_bucket, update_bucket |
writeFiles | abort_multipart_upload, complete_multipart_upload, copy_file, copy_part, hide_file, list_parts, start_multipart_upload, upload_file, upload_part |
writeKeys | create_app_key |
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 files 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 buckets and metadata collection 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 files and metadata collection 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
This method interrupts 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 app_keys 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 app_keys 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 buckets 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 files 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 files 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:
prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
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 files 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 files 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:
prefix Value | Files Returned | Folders Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1
MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB | (none) |
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 files 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 parts 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 parts 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:
- 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 query_params properties are added to the request URL.
- 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).
- Stores the response headers in the parsed_headers 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:
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:
Capability String | Related Methods |
deleteBuckets | delete_bucket |
deleteFiles | delete_file, delete_file_version |
deleteKeys | delete_app_key |
listBuckets | get_bucket_info, list_buckets |
listFiles | delete_file, list_files, list_file_versions, list_multipart_uploads |
listKeys | list_app_keys |
readFiles | copy_file, copy_part, download_file, download_file_by_id, get_file_info |
shareFiles | get_download_auth_token |
writeBuckets | create_bucket, update_bucket |
writeFiles | abort_multipart_upload, complete_multipart_upload, copy_file, copy_part, hide_file, list_parts, start_multipart_upload, upload_file, upload_part |
writeKeys | create_app_key |
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
Fired when information is available 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.
The ErrorCode parameter contains an error code, and the Description parameter 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:
folder | A "folder" (only applicable when listing files with a delimiter). |
hide | A hide marker file version created by hide_file. |
start | A multipart file upload that has not been completed or abandoned yet. |
upload | An file that has been uploaded (either directly, or via a multipart upload). |
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:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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
During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.
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
Fired when secure connection progress messages are available.
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. This event tracks 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
The class accepts one or more of the following configuration settings. Configuration 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.BackblazeB2 Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
Note that this setting cannot be changed, it is returned by the server when authorize is called.
Note that this setting cannot be changed.
This name and value format are the ones recommended by the Backblaze B2 API documentation to allow different clients to interoperate with each other. That said, it is still a normal metadata item as far as the server is concerned; this setting, as well as the file_modified_time property and the on_file_list event's ModifiedTime parameter, are provided as a convenience.
If this setting is non-empty when one of the aforementioned methods is called, the class will always add the src_last_modified_millis metadata item to the request before the items in the metadata properties. Keep in mind that a file cannot have more than 10 metadata items; the class does not enforce this limit, but the server will return an error if it is exceeded.
Using this setting is only necessary when downloading a file that the currently-authenticated application key does not have access to (either due to restrictions on the key, or because the file is owned by someone else's account). If this setting is set, then the DownloadURL typically needs to be set as well (just remember to back up its current value first, and restore that value after the download is finished).
This setting is not applicable to the download_file_by_id method.
When downloading encrypted data with local_file set, the class will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to local_file.
If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See download_file for details.
This setting's value should not be changed manually unless the DownloadAuthToken setting is being used (in which case the current value should be backed up so that it can be restored later); refer to that setting's documentation for more information.
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
Valid values are 5242880 (5MB) to 2147483647 (2GB). This setting is automatically set to match the account_rec_part_size property's value (or 2147483647, whichever is smaller) after the first successful call to authorize for a particular application_key/application_key_id combination. Subsequent calls to authorize will not change this setting's value unless application_key and/or application_key_id has changed, or reset has been called.
Note that applications may need to increase this setting's value in order to upload very large files; Backblaze B2 only allows 10000 parts to be uploaded for any given multipart upload.
If the amount of upload data present when upload_file is called is less than SimpleUploadLimit bytes, it will be uploaded directly, so this setting will not apply.
Note that calls to the aforementioned methods will never repopulate the metadata properties, regardless of this setting's value.
If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 10000 (inclusive).
If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 1000 (inclusive).
If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 10000 (inclusive).
If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the on_progress event will account for the data that was successfully transferred before the interruption.
If this setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the on_progress event will start at 0 rather than from the number of bytes already transferred.
Refer to the on_progress event for more information.
The default value, 1, will cause the on_progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the on_progress event to fire every time data is transferred.
Note that the on_progress event will always fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if PercentDone cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the class will behave as if this setting were 0 for the duration of the transfer.
Refer to upload_file for more information.
If this setting is disabled (default), or if this setting is enabled but there are no metadata items (and ClientModifiedTime is also empty), then the server will copy the source file's current metadata to the destination file.
Valid values are -1 to 5368709120 (5GB), inclusive. This setting is automatically set to twice the account_rec_part_size property's value after the first successful call to authorize for a particular application_key/application_key_id combination. Subsequent calls to authorize will not change this setting's value unless application_key and/or application_key_id has changed, or reset has been called.
If this setting is set to 0, the class will always perform a multipart upload to create a file; if it is set to -1, the class will never perform a multipart upload.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is False.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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).
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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed 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 setting 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 multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.
If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions that are designed to run on Windows, ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.
This configuration setting is applicable only when ssl_provider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when ssl_provider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
BackblazeB2 Errors
Common Errors
600 | A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information. |
601 | An unsupported operation or action was attempted. |
602 | The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON. |
603 | The login credentials specified were invalid. Please refer to the error message for more information. |
604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. |
605 | An invalid index was specified. |
606 | An upload was aborted by the user before it could finish. |
607 | The specified resource is a folder and cannot be downloaded. |
608 | A download failed because the specified local_file already exists and overwrite is False. |
609 | The class could not resume a download or upload. Please refer to the error message for more information. |
610 | An encrypted download could not be resumed because the DownloadTempFile configuration setting is not set. |
611 | An exception occurred while working with the specified local_file (or the current value of local_file is invalid). Please refer to the error message for more information. |
612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. |
BackblazeB2 Errors
700 | The current account_auth_token has expired or is otherwise no longer valid; call authorize to obtain a new one. |
701 | The specified DownloadAuthToken has expired or is otherwise no longer valid. |
702 | The request failed due to a temporary server error; try again, using exponential backoff if necessary. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 | Firewall Error. Error description contains detailed message. |
143 | Busy executing current method. |
151 | HTTP protocol error. The error message has the server response. |
152 | No server specified in url |
153 | Specified url_scheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the remote_port at this time. A connection is in progress. |
101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
102 | The remote_host address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the local_port at this time. A connection is in progress. |
107 | You cannot change the local_host at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | remote_port cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |