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

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 ApplicationKeyId and ApplicationKey properties, and then call Authorize. This will populate the Account property with the aforementioned information, including the AccountAuthToken.

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:

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.

AccountDetails about the account and restrictions associated with currently-authenticated application key.
AppKeyMarkerA marker indicating what page of application keys to return next.
AppKeysA collection of application keys.
ApplicationKeyThe application key to use for authentication.
ApplicationKeyIdThe application key Id to use for authentication.
BucketsA collection of buckets.
ContentTypeThe content type to send for a file.
DelimiterThe delimiter string to use when listing files.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FileDataThe data that was downloaded, or that should be uploaded.
FileMarkerA marker indicating what page of files to return next.
FilesA collection of files.
FirewallA set of properties related to firewall access.
IdleThe current status of the class.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MetadataA collection of metadata items.
OtherHeadersOther headers as determined by the user (optional).
OverwriteDetermines if local files are overwritten.
ParsedHeadersThis property includes a collection of headers returned from the last request.
PartMarkerA marker indicating what page of parts to return next.
PartsA collection of multipart upload parts.
PrefixA prefix used to restrict the results returned when listing files.
ProxyA set of properties related to proxy access.
QueryParamsAdditional query parameters to be included in the request.
RangeThe range of bytes to request.
SSLAcceptServerCertInstructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProviderThe Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCertThe server certificate for the last established connection.
StartByteThe byte offset from which to resume the upload or download.
TimeoutThe timeout for the class.
VersionMarkerA 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.

AbortMultipartUploadAborts a multipart upload.
AddMetadataAdds a metadata item to the Metadata properties.
AddQueryParamAdds a query parameter to the QueryParams properties.
AuthorizeAuthenticates the class with the server using the current application key and Id.
CompleteMultipartUploadCompletes a multipart upload by assembling the previously uploaded parts.
ConfigSets or retrieves a configuration setting.
CopyFileCopies a file.
CopyPartCopies the specified file as part of a multipart upload.
CreateAppKeyCreates a new application key.
CreateBucketCreates a new bucket.
DeleteAppKeyDeletes an application key.
DeleteBucketDeletes a bucket.
DeleteFileDeletes all versions of a file.
DeleteFileVersionDeletes a file version.
DownloadFileDownloads a file by name.
DownloadFileByIdDownloads a file by Id.
GetBucketInfoGets a bucket's information and metadata.
GetDownloadAuthTokenCreate a download authorization token for one or more files in a bucket.
GetFileInfoGets a file's information and metadata.
HideFileHides a file.
InterruptThis method interrupts the current method.
ListAppKeysLists the account's application keys.
ListBucketsLists all buckets in the account.
ListFilesLists the files in a bucket.
ListFileVersionsLists the file versions in a bucket.
ListMultipartUploadsLists the in-progress multipart uploads in a bucket.
ListPartsLists a multipart upload's parts.
ResetResets the class to its initial state.
SendCustomRequestSends a custom request to the Backblaze B2 API.
StartMultipartUploadStarts a new multipart upload.
UpdateBucketUpdates a bucket's kind and/or metadata.
UploadFileUploads a file.
UploadPartUploads 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.

AppKeyListFires once for each application key returned when listing application keys.
BucketListFires once for each bucket returned when listing buckets.
EndTransferThis event fires when a document finishes transferring.
ErrorFired when information is available about errors during data delivery.
FileListFires once for each file returned when listing files.
FragmentCompleteFires after each part in an automatic multipart upload is complete.
HeaderFired every time a header line comes in.
LogFired once for each log message.
MetadataListFires once for each metadata item returned when bucket or file information and metadata is retrieved.
PartListFires once for each part returned when listing a multipart upload's parts.
ProgressFires during an upload or download to indicate transfer progress.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StartTransferThis event fires when a document starts transferring (after the headers).
TransferFired 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.

AccumulatePagesWhether the class should accumulate subsequent pages of results when listing them.
APIURLThe base URL used for all except download and upload requests.
APIVersionThe Backblaze B2 REST API version being used by the class.
ClientModifiedTimeThe client-side last modified time.
DownloadAuthTokenThe download authorization token to use.
DownloadTempFileThe temporary file used when downloading encrypted data.
DownloadURLThe base URL used for download requests.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
EncryptionPasswordKDFThe KDF algorithm to use during password based encryption and decryption.
FragmentSizeThe part size to use when uploading a new file.
IfRevisionThe revision number that the bucket must currently have in order for a request to succeed.
ListWithMetadataWhether to include metadata items when listing buckets, files, etc.
MaxAppKeyResultsThe maximum number of results to return when listing application keys.
MaxPartResultsThe maximum number of results to return when listing parts.
MaxResultsThe maximum number of results to return when listing files or file versions.
ProgressAbsoluteWhether the class should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
ResumableUploadStateTracks upload state information during an automatic multipart upload.
SendMetadataOnCopyWhether to send metadata items when copying files.
SimpleUploadLimitThe maximum data size the class should attempt to upload directly when creating a file.
TempPathThe path to the directory where temporary files are created.
XChildCountThe 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.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLAcceptAnyServerCertWhether to trust any certificate presented by the server.
SSLCACertsA newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLClientCACertsA newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

BackblazeB2.Account Property

Details about the account and restrictions associated with currently-authenticated application key.

Syntax

getAccount(): B2Account;

Default Value

Remarks

This property holds an B2Account object with information about the account and restrictions associated with the currently-authenticated application key; it's populated after calling Authorize.

This property is read-only and not available at design time.

Please refer to the B2Account type for a complete list of fields.

BackblazeB2.AppKeyMarker Property

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

Syntax

getAppKeyMarker(): string;
setAppKeyMarker(appKeyMarker: string): void;

Default Value

""

Remarks

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

Refer to ListAppKeys for more information.

This property is not available at design time.

BackblazeB2.AppKeys Property

A collection of application keys.

Syntax

getAppKeys(): B2AppKeyList;

Default Value

Remarks

This collection holds a list of B2AppKey items.

Calling ListAppKeys will populate this collection.

This property is read-only and not available at design time.

Please refer to the B2AppKey type for a complete list of fields.

BackblazeB2.ApplicationKey Property

The application key to use for authentication.

Syntax

getApplicationKey(): string;
setApplicationKey(applicationKey: string): void;

Default Value

""

Remarks

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

BackblazeB2.ApplicationKeyId Property

The application key Id to use for authentication.

Syntax

getApplicationKeyId(): string;
setApplicationKeyId(applicationKeyId: string): void;

Default Value

""

Remarks

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

BackblazeB2.Buckets Property

A collection of buckets.

Syntax

getBuckets(): B2BucketList;

Default Value

Remarks

This collection holds a list of B2Bucket items.

Calling ListBuckets will populate this collection.

This property is read-only and not available at design time.

Please refer to the B2Bucket type for a complete list of fields.

BackblazeB2.ContentType Property

The content type to send for a file.

Syntax

getContentType(): string;
setContentType(contentType: string): void;

Default Value

""

Remarks

This property can be set before calling UploadFile, StartMultipartUpload, or (if the SendMetadataOnCopy configuration setting is enabled) CopyFile 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).

This property is not available at design time.

BackblazeB2.Delimiter Property

The delimiter string to use when listing files.

Syntax

getDelimiter(): string;
setDelimiter(delimiter: string): void;

Default Value

""

Remarks

If this property is non-empty when ListFiles or ListFileVersions 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 FilesKind property will be set to folder. The same is also true of the FileList 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 ListFiles or ListFileVersions 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)

This property is not available at design time.

BackblazeB2.EncryptionAlgorithm Property

The encryption algorithm.

Syntax

getEncryptionAlgorithm(): BackblazeB2EncryptionAlgorithms;
setEncryptionAlgorithm(encryptionAlgorithm: BackblazeB2EncryptionAlgorithms): void;

enum BackblazeB2EncryptionAlgorithms { eaAES, eaBlowfish, eaCAST, eaDES, eaIDEA, eaRC2, eaRC4, eaTEA, eaTripleDES, eaTwofish, eaRijndael, eaChaCha, eaXSalsa20 }

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

BackblazeB2.EncryptionPassword Property

The encryption password.

Syntax

getEncryptionPassword(): string;
setEncryptionPassword(encryptionPassword: string): void;

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile 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.

This property is not available at design time.

BackblazeB2.FileData Property

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

Syntax

getFileData(): Uint8Array;
setFileData(fileData: Uint8Array): void;

Default Value

""

Remarks

This property is populated with file data after calling DownloadFile or DownloadFileById if LocalFile is not set.

This property can also be set before calling UploadFile or UploadPart; its data will be uploaded if LocalFile is not set.

This property is not available at design time.

BackblazeB2.FileMarker Property

A marker indicating what page of files to return next.

Syntax

getFileMarker(): string;
setFileMarker(fileMarker: string): void;

Default Value

""

Remarks

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

Refer to ListFiles or ListMultipartUploads for more information.

This property is not available at design time.

BackblazeB2.Files Property

A collection of files.

Syntax

getFiles(): B2FileList;

Default Value

Remarks

This collection holds a list of B2File items.

Calling GetFileInfo, ListFiles, ListFileVersions, or ListMultipartUploads will populate this collection.

This property is read-only and not available at design time.

Please refer to the B2File type for a complete list of fields.

BackblazeB2.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

BackblazeB2.Idle Property

The current status of the class.

Syntax

isIdle(): boolean;

Default Value

TRUE

Remarks

This property 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.

BackblazeB2.LocalFile Property

The location of the local file.

Syntax

getLocalFile(): string;
setLocalFile(localFile: string): void;

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or UploadPart; and as the destination file when calling DownloadFile or DownloadFileById.

BackblazeB2.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

""

Remarks

This 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 LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

BackblazeB2.Metadata Property

A collection of metadata items.

Syntax

getMetadata(): B2MetadataList;
setMetadata(metadata: B2MetadataList): void;

Default Value

Remarks

This collection holds a list of B2Metadata items.

This collection is populated when GetBucketInfo or GetFileInfo is called; and its items are used anytime one of the following methods is called:

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.

This property is not available at design time.

Please refer to the B2Metadata type for a complete list of fields.

BackblazeB2.OtherHeaders Property

Other headers as determined by the user (optional).

Syntax

getOtherHeaders(): string;
setOtherHeaders(otherHeaders: string): void;

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 ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by .

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.

This property is not available at design time.

BackblazeB2.Overwrite Property

Determines if local files are overwritten.

Syntax

isOverwrite(): boolean;
setOverwrite(overwrite: boolean): void;

Default Value

FALSE

Remarks

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

BackblazeB2.ParsedHeaders Property

This property includes a collection of headers returned from the last request.

Syntax

getParsedHeaders(): HeaderList;

Default Value

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Please refer to the Header type for a complete list of fields.

BackblazeB2.PartMarker Property

A marker indicating what page of parts to return next.

Syntax

getPartMarker(): string;
setPartMarker(partMarker: string): void;

Default Value

""

Remarks

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

Refer to ListParts for more information.

This property is not available at design time.

BackblazeB2.Parts Property

A collection of multipart upload parts.

Syntax

getParts(): B2PartList;

Default Value

Remarks

This collection holds a list of B2Part items.

Calling ListParts will populate this collection.

This property is read-only and not available at design time.

Please refer to the B2Part type for a complete list of fields.

BackblazeB2.Prefix Property

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

Syntax

getPrefix(): string;
setPrefix(prefix: string): void;

Default Value

""

Remarks

This property, if non-empty, is used to restrict the values returned by ListFiles, ListFileVersions, or ListMultipartUploads 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 AccountAllowedPrefix 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 ListFiles or ListFileVersions 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)

This property is not available at design time.

BackblazeB2.Proxy Property

A set of properties related to proxy access.

Syntax

getProxy(): Proxy;
setProxy(proxy: Proxy): void;

Default Value

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

BackblazeB2.QueryParams Property

Additional query parameters to be included in the request.

Syntax

getQueryParams(): QueryParamList;
setQueryParams(queryParams: QueryParamList): void;

Default Value

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Please refer to the QueryParam type for a complete list of fields.

BackblazeB2.Range Property

The range of bytes to request.

Syntax

getRange(): string;
setRange(range: string): void;

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a DownloadFile or DownloadFileById 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 StartByte 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 StartByte 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.

This property is not available at design time.

BackblazeB2.SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

BackblazeB2.SSLCert Property

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

BackblazeB2.SSLProvider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

getSSLProvider(): BackblazeB2SSLProviders;
setSSLProvider(SSLProvider: BackblazeB2SSLProviders): void;

enum BackblazeB2SSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }

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.
Additional Notes

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, the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The internal provider is not support at this time.

BackblazeB2.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

BackblazeB2.StartByte Property

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

Syntax

getStartByte(): number;
setStartByte(startByte: number): void;

Default Value

0

Remarks

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

This property is not available at design time.

BackblazeB2.Timeout Property

The timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

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 DoEvents 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 .

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.

BackblazeB2.VersionMarker Property

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

Syntax

getVersionMarker(): string;
setVersionMarker(versionMarker: string): void;

Default Value

""

Remarks

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

Refer to ListFileVersions for more information.

This property is not available at design time.

BackblazeB2.abortMultipartUpload Method

Aborts a multipart upload.

Syntax

async backblazeb2.abortMultipartUpload(multipartFileId : string): Promise<void>

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 AccountCapabilities property for more information.

BackblazeB2.addMetadata Method

Adds a metadata item to the Metadata properties.

Syntax

async backblazeb2.addMetadata(name : string, value : string): Promise<void>

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.

BackblazeB2.addQueryParam Method

Adds a query parameter to the QueryParams properties.

Syntax

async backblazeb2.addQueryParam(name : string, value : string): Promise<void>

Remarks

This method is used to add a query parameter to the QueryParams 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.

BackblazeB2.authorize Method

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

Syntax

async backblazeb2.authorize(): Promise<void>

Remarks

This method authenticates the class with the server using the values held by ApplicationKey and ApplicationKeyId. 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.

BackblazeB2.completeMultipartUpload Method

Completes a multipart upload by assembling the previously uploaded parts.

Syntax

async backblazeb2.completeMultipartUpload(multipartFileId : string): Promise<void>

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 ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts properties, nor does it cause the PartList 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 AccountCapabilities property for more information.

BackblazeB2.config Method

Sets or retrieves a configuration setting.

Syntax

async backblazeb2.config(configurationString : string): Promise<string>

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.

BackblazeB2.copyFile Method

Copies a file.

Syntax

async backblazeb2.copyFile(srcFileId : string, destBucketId : string, destFileName : string): Promise<string>

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 UploadFile 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 ContentType 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 StartMultipartUpload, and then use the CopyPart 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 AccountCapabilities property for more information.

BackblazeB2.copyPart Method

Copies the specified file as part of a multipart upload.

Syntax

async backblazeb2.copyPart(srcFileId : string, multipartFileId : string, partNumber : number): Promise<void>

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 AccountCapabilities property for more information.

BackblazeB2.createAppKey Method

Creates a new application key.

Syntax

async backblazeb2.createAppKey(keyName : string, capabilities : string, allowedBucketId : string, allowedPrefix : string, validityDuration : number): Promise<string>

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 ListAppKeys 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:

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 AccountCapabilities property for more information.

BackblazeB2.createBucket Method

Creates a new bucket.

Syntax

async backblazeb2.createBucket(bucketName : string, kind : string): Promise<string>

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 AccountCapabilities property for more information.

BackblazeB2.deleteAppKey Method

Deletes an application key.

Syntax

async backblazeb2.deleteAppKey(keyId : string): Promise<void>

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 AccountCapabilities property for more information.

BackblazeB2.deleteBucket Method

Deletes a bucket.

Syntax

async backblazeb2.deleteBucket(bucketId : string): Promise<void>

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 AccountCapabilities property for more information.

BackblazeB2.deleteFile Method

Deletes all versions of a file.

Syntax

async backblazeb2.deleteFile(bucketId : string, fileName : string): Promise<void>

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 AccountCapabilities 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 ListFileVersions to obtain a list of all versions of the specified file, and then uses DeleteFileVersion 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 FileMarker properties, nor does it cause the FileList event to fire.

BackblazeB2.deleteFileVersion Method

Deletes a file version.

Syntax

async backblazeb2.deleteFileVersion(fileId : string): Promise<void>

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 HideFile 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 AccountCapabilities property for more information.

BackblazeB2.downloadFile Method

Downloads a file by name.

Syntax

async backblazeb2.downloadFile(bucketName : string, fileName : string): Promise<void>

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 LocalFile is set, the file data will be saved to the specified location; otherwise, the file data will be held by FileData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword 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 StartByte property. If a download is interrupted, set StartByte 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 LocalFile was set in the initial download attempt.

If LocalFile 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 StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. 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 AccountCapabilities property for more information.

BackblazeB2.downloadFileById Method

Downloads a file by Id.

Syntax

async backblazeb2.downloadFileById(fileId : string): Promise<void>

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 LocalFile is set, the file data will be saved to the specified location; otherwise, the file data will be held by FileData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword 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 StartByte property. If a download is interrupted, set StartByte 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 LocalFile was set in the initial download attempt.

If LocalFile 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 StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. 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 AccountCapabilities property for more information.

BackblazeB2.getBucketInfo Method

Gets a bucket's information and metadata.

Syntax

async backblazeb2.getBucketInfo(bucketId : string): Promise<void>

Remarks

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

Calling this method will fire the BucketList and MetadataList 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 AccountCapabilities property for more information.

BackblazeB2.getDownloadAuthToken Method

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

Syntax

async backblazeb2.getDownloadAuthToken(allowedBucketId : string, allowedPrefix : string, validityDuration : number): Promise<string>

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 DownloadFile 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 AccountCapabilities property for more information.

BackblazeB2.getFileInfo Method

Gets a file's information and metadata.

Syntax

async backblazeb2.getFileInfo(fileId : string): Promise<void>

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 FileList and MetadataList 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 AccountCapabilities property for more information.

BackblazeB2.hideFile Method

Hides a file.

Syntax

async backblazeb2.hideFile(bucketId : string, fileName : string): Promise<string>

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 ListFiles, nor can it be downloaded by name using DownloadFile. However:

  • Any version of the file (excluding hide markers) can still be downloaded directly using DownloadFileById.
  • All versions of the file can still be deleted, either all at once using DeleteFile, or individually using DeleteFileVersion.
  • All versions of the file will still appear in the results returned by ListFileVersions, and can still be queried individually using GetFileInfo.

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

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 AccountCapabilities property for more information.

BackblazeB2.interrupt Method

This method interrupts the current method.

Syntax

async backblazeb2.interrupt(): Promise<void>

Remarks

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

BackblazeB2.listAppKeys Method

Lists the account's application keys.

Syntax

async backblazeb2.listAppKeys(): Promise<void>

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 AppKeyList event once for each application key, and will also populate the AppKeys properties.

If there are still more application keys available to list when this method returns, the AppKeyMarker property will be populated. Continue to call this method until AppKeyMarker is empty to accumulate all pages of results in the AppKeys properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the AppKeys properties every time a page of results is returned.

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 AccountCapabilities property for more information.

BackblazeB2.listBuckets Method

Lists all buckets in the account.

Syntax

async backblazeb2.listBuckets(): Promise<void>

Remarks

This method lists all buckets in the account.

Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets properties. If the ListWithMetadata configuration setting is enabled, the MetadataList 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 AccountAllowedBucketId 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 AccountCapabilities property for more information.

BackblazeB2.listFiles Method

Lists the files in a bucket.

Syntax

async backblazeb2.listFiles(bucketId : string): Promise<void>

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 AccountAllowedPrefix 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 FileList event once for each file, and will also populate the Files properties. If the ListWithMetadata configuration setting is enabled, the MetadataList 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 FileMarker property will be populated. Continue to call this method until FileMarker is empty to accumulate all pages of results in the Files properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Files properties every time a page of results is returned.

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 AccountCapabilities 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 ListFiles or ListFileVersions 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)

BackblazeB2.listFileVersions Method

Lists the file versions in a bucket.

Syntax

async backblazeb2.listFileVersions(bucketId : string): Promise<void>

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 AccountAllowedPrefix 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 FileList event once for each file version, and will also populate the Files properties. If the ListWithMetadata configuration setting is enabled, the MetadataList 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 VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Files properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Files properties every time a page of results is returned.

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 AccountCapabilities 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 ListFiles or ListFileVersions 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)

BackblazeB2.listMultipartUploads Method

Lists the in-progress multipart uploads in a bucket.

Syntax

async backblazeb2.listMultipartUploads(bucketId : string): Promise<void>

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 AccountAllowedPrefix 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 FileList event once for each multipart upload, and will also populate the Files properties. If the ListWithMetadata configuration setting is enabled, the MetadataList 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 AccountCapabilities property for more information.

BackblazeB2.listParts Method

Lists a multipart upload's parts.

Syntax

async backblazeb2.listParts(multipartFileId : string): Promise<void>

Remarks

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

Calling this method will fire the PartList 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 PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Parts properties every time a page of results is returned.

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 AccountCapabilities property for more information.

BackblazeB2.reset Method

Resets the class to its initial state.

Syntax

async backblazeb2.reset(): Promise<void>

Remarks

This method resets the class to its initial state.

BackblazeB2.sendCustomRequest Method

Sends a custom request to the Backblaze B2 API.

Syntax

async backblazeb2.sendCustomRequest(httpMethod : string, operation : string, requestBody : string): Promise<void>

Remarks

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

Valid values for HttpMethod are:

  • GET (default if empty)
  • HEAD
  • POST

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

Usage

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

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

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.

BackblazeB2.startMultipartUpload Method

Starts a new multipart upload.

Syntax

async backblazeb2.startMultipartUpload(bucketId : string, fileName : string): Promise<string>

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 UploadFile 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 CompleteMultipartUpload:

  • 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 ContentType property.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads 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 AccountCapabilities property for more information.

BackblazeB2.updateBucket Method

Updates a bucket's kind and/or metadata.

Syntax

async backblazeb2.updateBucket(bucketId : string, newKind : string, newMetadata : boolean): Promise<void>

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 AccountCapabilities property for more information.

BackblazeB2.uploadFile Method

Uploads a file.

Syntax

async backblazeb2.uploadFile(bucketId : string, fileName : string): Promise<string>

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 ContentType property.

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

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

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 AccountCapabilities 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 StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete 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 StartByte contain the same values as they did when the upload was interrupted.

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

BackblazeB2.uploadPart Method

Uploads a multipart upload part.

Syntax

async backblazeb2.uploadPart(multipartFileId : string, partNumber : number): Promise<void>

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 LocalFile or FileData (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 AccountCapabilities property for more information.

BackblazeB2.AppKeyList Event

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

Syntax

backblazeb2.on('AppKeyList', listener: (e: {readonly keyId: string, readonly keyName: string, readonly capabilities: string, readonly allowedBucketId: string, readonly allowedPrefix: string, readonly expirationTime: number}) => void )

Remarks

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

KeyId reflects the unique Id of the application key.

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

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

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

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

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

BackblazeB2.BucketList Event

Fires once for each bucket returned when listing buckets.

Syntax

backblazeb2.on('BucketList', listener: (e: {readonly id: string, readonly name: string, readonly kind: string, readonly revision: number}) => void )

Remarks

This event fires once for each bucket returned when ListBuckets 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.

BackblazeB2.EndTransfer Event

This event fires when a document finishes transferring.

Syntax

backblazeb2.on('EndTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The EndTransfer 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.

BackblazeB2.Error Event

Fired when information is available about errors during data delivery.

Syntax

backblazeb2.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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.

BackblazeB2.FileList Event

Fires once for each file returned when listing files.

Syntax

backblazeb2.on('FileList', listener: (e: {readonly id: string, readonly name: string, readonly bucketId: string, readonly size: number, readonly contentType: string, readonly createdTime: number, readonly modifiedTime: number, readonly kind: string, readonly SHA1Hash: string}) => void )

Remarks

This event fires once for each file returned when ListFiles, ListFileVersions, or ListMultipartUploads 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 HideFile.
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.

BackblazeB2.FragmentComplete Event

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

Syntax

backblazeb2.on('FragmentComplete', listener: (e: {readonly fragmentNumber: number, readonly fragmentCount: number, interrupt: boolean}) => void )

Remarks

If, when UploadFile 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 UploadFile for more information.

BackblazeB2.Header Event

Fired every time a header line comes in.

Syntax

backblazeb2.on('Header', listener: (e: {readonly field: string, readonly value: string}) => void )

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).

BackblazeB2.Log Event

Fired once for each log message.

Syntax

backblazeb2.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

Remarks

This event is fired 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"

BackblazeB2.MetadataList Event

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

Syntax

backblazeb2.on('MetadataList', listener: (e: {readonly bucketId: string, readonly fileId: string, readonly name: string, readonly value: string}) => void )

Remarks

This event fires once for each metadata item returned when GetBucketInfo or GetFileInfo is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual bucket or file is returned when ListBuckets, ListFiles, ListFileVersions, or ListMultipartUploads 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.

BackblazeB2.PartList Event

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

Syntax

backblazeb2.on('PartList', listener: (e: {readonly partNumber: number, readonly multipartFileId: string, readonly size: number, readonly createdTime: number, readonly SHA1Hash: string}) => void )

Remarks

This event fires once for each part returned when ListParts 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.

BackblazeB2.Progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

backblazeb2.on('Progress', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly totalBytes: number, readonly percentDone: number}) => void )

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.

BackblazeB2.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

backblazeb2.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

BackblazeB2.SSLStatus Event

Fired when secure connection progress messages are available.

Syntax

backblazeb2.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

BackblazeB2.StartTransfer Event

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

Syntax

backblazeb2.on('StartTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The StartTransfer 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.

BackblazeB2.Transfer Event

Fired while a document transfers (delivers document).

Syntax

backblazeb2.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )

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.

B2Account Type

Backblaze B2 account information.

Remarks

This type provides information about a Backblaze B2 account and the currently-authenticated application key.

The following fields are available:

Fields

AccountId
string (read-only)

Default Value: ""

The Id of the account.

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

AllowedBucketId
string (read-only)

Default Value: ""

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.

AllowedBucketName
string (read-only)

Default Value: ""

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 ( will still be populated in this case).

AllowedPrefix
string (read-only)

Default Value: ""

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.

AuthToken
string (read-only)

Default Value: ""

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 ApplicationKey and ApplicationKeyId values; it is valid for up to 24 hours.

Capabilities
string (read-only)

Default Value: ""

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:

MinPartSize
number (read-only)

Default Value: -1

The minimum allowed multipart upload part size.

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

RecPartSize
number (read-only)

Default Value: -1

The recommended multipart upload part size.

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

B2AppKey Type

A Backblaze B2 application key.

Remarks

This type represents a Backblaze B2 application key.

The following fields are available:

Fields

AllowedBucketId
string (read-only)

Default Value: ""

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.

AllowedPrefix
string (read-only)

Default Value: ""

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.

Capabilities
string (read-only)

Default Value: ""

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:

ExpirationTime
number (read-only)

Default Value: -1

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.

KeyId
string (read-only)

Default Value: ""

The Id of the application key.

This property reflects the unique Id of the application key.

Name
string (read-only)

Default Value: ""

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.

B2Bucket Type

A Backblaze B2 bucket.

Remarks

This type represents a Backblaze B2 bucket.

The following fields are available:

Fields

Id
string (read-only)

Default Value: ""

The Id of the bucket.

This property reflects the unique Id of the bucket.

Kind
string (read-only)

Default Value: ""

The kind of bucket.

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

Name
string (read-only)

Default Value: ""

The name of the bucket.

This property reflects the name of the bucket.

Revision
number (read-only)

Default Value: -1

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.

B2File Type

A Backblaze B2 file.

Remarks

This type represents a Backblaze B2 file.

The following fields are available:

Fields

BucketId
string (read-only)

Default Value: ""

The Id of the bucket that the file is in.

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

ContentType
string (read-only)

Default Value: ""

The content type of the file.

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

CreatedTime
number (read-only)

Default Value: -1

The file's creation time.

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

Id
string (read-only)

Default Value: ""

The Id of the file.

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

Kind
string (read-only)

Default Value: ""

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 HideFile.
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).

MD5Hash
string (read-only)

Default Value: ""

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.

ModifiedTime
number (read-only)

Default Value: -1

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.

Name
string (read-only)

Default Value: ""

The name of the file.

This property reflects the name of the file.

SHA1Hash
string (read-only)

Default Value: ""

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 is folder or hide.

Size
number (read-only)

Default Value: 0

The file's size.

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

B2Metadata Type

A Backblaze B2 metadata item.

Remarks

This type represents a Backblaze B2 metadata item.

The following fields are available:

Fields

Name
string

Default Value: ""

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 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.

Value
string

Default Value: ""

The value of the metadata item.

This property specifies the value of the metadata item.

Constructors

public B2Metadata();
public B2Metadata(String name, String value);

B2Part Type

A Backblaze B2 multipart upload part.

Remarks

This type represents a Backblaze B2 multipart upload part.

The following fields are available:

Fields

CreatedTime
number (read-only)

Default Value: -1

The part's creation time.

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

MD5Hash
string (read-only)

Default Value: ""

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.

PartNumber
number (read-only)

Default Value: -1

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.

SHA1Hash
string (read-only)

Default Value: ""

A SHA1 hash of the part's contents.

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

Size
number (read-only)

Default Value: 0

The part's size.

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

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
string (read-only)

Default Value: ""

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.

ExpirationDate
string (read-only)

Default Value: ""

The date on which 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.

ExtendedKeyUsage
string (read-only)

Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
string (read-only)

Default Value: ""

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

FingerprintSHA1
string (read-only)

Default Value: ""

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

FingerprintSHA256
string (read-only)

Default Value: ""

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

Issuer
string (read-only)

Default Value: ""

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
string

Default Value: ""

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys.

Note: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

PrivateKey
string (read-only)

Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The may be available but not exportable. In this case, returns an empty string.

PrivateKeyAvailable
boolean (read-only)

Default Value: False

Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string (read-only)

Default Value: ""

The name of the container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
string (read-only)

Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
string (read-only)

Default Value: ""

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.

PublicKeyLength
number (read-only)

Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
string (read-only)

Default Value: ""

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.

SignatureAlgorithm
string (read-only)

Default Value: ""

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.

Store
string

Default Value: "MY"

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
Uint8Array

Default Value: "MY"

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
string

Default Value: ""

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

StoreType
CertStoreTypes

Default Value: 0

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 ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the and set to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

SubjectAltNames
string (read-only)

Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)

Default Value: ""

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.

ThumbprintSHA1
string (read-only)

Default Value: ""

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.

ThumbprintSHA256
string (read-only)

Default Value: ""

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.

Usage
string (read-only)

Default Value: ""

The text description of .

This value will be 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.

UsageFlags
number (read-only)

Default Value: 0

The flags that show intended use for the certificate. The value of is a combination of the following flags:

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the property for a text representation of .

This functionality currently is not available when the provider is OpenSSL.

Version
string (read-only)

Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
string

Default Value: ""

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Encoded
string

Default Value: ""

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

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

EncodedB
Uint8Array

Default Value: ""

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

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

Constructors

public Certificate();

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] encoded);

Parses Encoded as an X.509 public key.

public Certificate(int storeType, String store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, String store, String storePassword, byte[] encoded);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(int storeType, byte[] store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

The following fields are available:

Fields

AutoDetect
boolean

Default Value: False

Whether to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes

Default Value: 0

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. is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. is set to 1080.

Host
string

Default Value: ""

The name or IP address of the firewall (optional). If a 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 .

Password
string

Default Value: ""

A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

Port
number

Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details.

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

User
string

Default Value: ""

A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

Constructors

public Firewall();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

The following fields are available:

Fields

Field
string

Default Value: ""

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

Value
string

Default Value: ""

This property contains the Header contents.

Constructors

public Header();
public Header(String field, String value);

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

The following fields are available:

Fields

AuthScheme
ProxyAuthSchemes

Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.

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

By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication.

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

If 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 is set to authNtlm (4), NTLM authentication will be used.

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

AutoDetect
boolean

Default Value: False

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Password
string

Default Value: ""

A password if authentication is to be used for the proxy.

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

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

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

Port
number

Default Value: 80

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

Server
string

Default Value: ""

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

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

SSL
ProxySSLTypes

Default Value: 0

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.

User
string

Default Value: ""

A username if authentication is to be used for the proxy.

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

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

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

Constructors

public Proxy();
public Proxy(String server, int port);
public Proxy(String server, int port, String user, String password);

QueryParam Type

A query parameter to send in the request.

Remarks

This type represents a query parameter to send in the request.

The following fields are available:

Fields

Name
string

Default Value: ""

The name of the query parameter.

This property specifies the name of the query parameter.

Value
string

Default Value: ""

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.

Constructors

public QueryParam();
public QueryParam(String name, String value);

Config Settings (class cloudstorage.backblazeb2)

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

AccumulatePages:   Whether the class should accumulate subsequent pages of results when listing them.

This setting controls how the class behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned.

By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.

APIURL:   The base URL used for all except download and upload requests.

After Authorize is called, this setting can be queried to obtain the base URL that the class will use for all further requests (except for download and upload requests).

Note that this setting cannot be changed, it is returned by the server when Authorize is called.

APIVersion:   The Backblaze B2 REST API version being used by the class.

This setting can be queried to obtain the version of the Backblaze B2 REST APIs being used by the class.

Note that this setting cannot be changed.

ClientModifiedTime:   The client-side last modified time.

This setting may be set to a number of milliseconds relative to the Unix epoch before calling UploadFile, StartMultipartUpload, or (if SendMetadataOnCopy is enabled) CopyFile to have the class automatically include a metadata item named src_last_modified_millis with the given value in the request.

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 FilesModifiedTime property and the FileList 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.

DownloadAuthToken:   The download authorization token to use.

This setting can be set before calling DownloadFile to have the class use the given download authorization token to authorize the request instead of the general-purpose AccountAuthToken for the currently-authenticated application key.

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 DownloadFileById method.

DownloadTempFile:   The temporary file used when downloading encrypted data.

This setting specifies the temporary file used when downloading encrypted data.

When downloading encrypted data with LocalFile 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 LocalFile.

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 DownloadFile for details.

DownloadURL:   The base URL used for download requests.

After Authorize is called, this setting can be queried to obtain the base URL that the class will use for downloading files.

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.

EncryptionIV:   The initialization vector to be used for encryption/decryption.

When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the class will derive this value automatically from EncryptionPassword.

This setting accepts a hex encoded value.

EncryptionKey:   The key to use during encryption/decryption.

When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the class will derive this value automatically from EncryptionPassword.

This setting accepts a hex encoded value.

EncryptionPasswordKDF:   The KDF algorithm to use during password based encryption and decryption.

This setting specified the Key Derivation Function (KDF) used to derive a key from the specified EncryptionPassword. Possible values are:

  • 0 (default) - PBKDF1
  • 1 - PBKDF2
Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used.

FragmentSize:   The part size to use when uploading a new file.

If, when UploadFile is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data into parts and perform a multipart upload. This setting specifies the part size to use.

Valid values are 5242880 (5MB) to 2147483647 (2GB). This setting is automatically set to match the AccountRecPartSize property's value (or 2147483647, whichever is smaller) after the first successful call to Authorize for a particular ApplicationKey/ApplicationKeyId combination. Subsequent calls to Authorize will not change this setting's value unless ApplicationKey and/or ApplicationKeyId 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 UploadFile is called is less than SimpleUploadLimit bytes, it will be uploaded directly, so this setting will not apply.

IfRevision:   The revision number that the bucket must currently have in order for a request to succeed.

This setting can be set to a bucket revision number before calling UpdateBucket to ensure that the request will only succeed if the bucket's current revision number matches the given one.

ListWithMetadata:   Whether to include metadata items when listing buckets, files, etc.

This setting indicates whether the class should fire the MetadataList event for the metadata items included with each result returned when ListBuckets, ListFiles, ListFileVersions, or ListMultipartUploads is called. It is disabled by default.

Note that calls to the aforementioned methods will never repopulate the Metadata properties, regardless of this setting's value.

MaxAppKeyResults:   The maximum number of results to return when listing application keys.

This setting specifies the maximum number of results that should be returned by a call to ListAppKeys.

If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 10000 (inclusive).

MaxPartResults:   The maximum number of results to return when listing parts.

This setting specifies the maximum number of results that should be returned by a call to ListParts.

If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 1000 (inclusive).

MaxResults:   The maximum number of results to return when listing files or file versions.

This setting specifies the maximum number of results that should be returned by a call to ListFiles or ListFileVersions.

If this setting is -1 (default), the server's default (100) is used. Acceptable values are 1 to 10000 (inclusive).

ProgressAbsolute:   Whether the class should track transfer progress absolutely.

This setting controls whether the class tracks upload and download progress absolutely or relatively, with regards to the values reported via the Progress event when an interrupted transfer is resumed.

If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the 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 Progress event will start at 0 rather than from the number of bytes already transferred.

Refer to the Progress event for more information.

ProgressStep:   How often the progress event should be fired, in terms of percentage.

This setting controls how often the class will fire the Progress event during an upload or download, in terms of percentage. Valid values are 0 to 99, inclusive.

The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.

Note that the 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.

RawRequest:   Returns the data that was sent to the server.

This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes.

RawResponse:   Returns the data that was received from the server.

This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes.

ResumableUploadState:   Tracks upload state information during an automatic multipart upload.

If, when UploadFile is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data into parts and perform a multipart upload. This setting keeps track of upload state information needed to resume the upload if it's interrupted.

Refer to UploadFile for more information.

SendMetadataOnCopy:   Whether to send metadata items when copying files.

This setting specifies whether the class should include Metadata items, to apply to the destination file, when CopyFile is called.

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.

SimpleUploadLimit:   The maximum data size the class should attempt to upload directly when creating a file.

When UploadFile is called, the class will automatically split the upload data into parts and perform a multipart upload if its size is greater than the amount specified by this setting. If the upload data size is less than or equal to the amount specified by this setting, it will be uploaded directly.

Valid values are -1 to 5368709120 (5GB), inclusive. This setting is automatically set to twice the AccountRecPartSize property's value after the first successful call to Authorize for a particular ApplicationKey/ApplicationKeyId combination. Subsequent calls to Authorize will not change this setting's value unless ApplicationKey and/or ApplicationKeyId 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.

TempPath:   The path to the directory where temporary files are created.

This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to DownloadTempFile and DownloadFile for more information.

XChildCount:   The number of child elements of the current element.

This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XChildName[i]:   The name of the child element.

This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XChildXText[i]:   The inner text of the child element.

This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XElement:   The name of the current element.

This configuration setting provides the name of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XParent:   The parent of the current element.

This configuration setting provides the parent of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XPath:   Provides a way to point to a specific element in the returned XML or JSON response.

The XPath setting allows you to point to specific elements in the XML or JSON response.

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.
Note: XPath indices are 1-based.

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:

DescriptionXML 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.

XSubTree:   A snapshot of the current element in the document.

This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XText:   The text of the current element.

This configuration setting provides the inner text of the current element.

The current element is specified in the XPath configuration setting. This configuration setting is read-only.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

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.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

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 if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

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 AuthScheme 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]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

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 .

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 Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the 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 instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "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.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. 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).

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .

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.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.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"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

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.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.

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.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

Possible values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect 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.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

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.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 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 LocalHost 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).

LocalPort:   The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort 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.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn 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 DataIn 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.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:

0 IPv4 only
1 IPv6 only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

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.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

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".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

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.

ReuseSSLSession:   Determines if the SSL session is reused.

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.

SSLAcceptAnyServerCert:   Whether to trust any certificate presented by the server.

This configuration setting disables all certificate verification when set to True. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

SSLCACerts:   A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. 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-----

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

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 SSLStatus 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.

SSLClientCACerts:   A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

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-----

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

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 SSLProvider 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 SSLProvider 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
Example values when SSLProvider is set to Internalinclude the following: 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 SSLProvider 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.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default - Client and Server)
TLS1.1768 (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:

In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

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 SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

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]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

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]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

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]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

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]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

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]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

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]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown certificate authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown certificate authority revocation status.
0x00000800Ignore unknown root revocation status.
0x00008000Allow test root certificate.
0x00004000Trust test root certificate.
0x80000000Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

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-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

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 .

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.

TLS12SupportedGroups:   The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider 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)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

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"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

  • "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 rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

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

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

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.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

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

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • 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.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

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.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (class cloudstorage.backblazeb2)

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 LocalFile 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 LocalFile (or the current value of LocalFile 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 AccountAuthToken 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.

HTTP Errors

118   Firewall error. The error description contains the 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 URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Cannot open AttachedFile.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost 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 LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort 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).