BackblazeB2 Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudStorage_BackblazeB2

Procedural Interface

 cloudstorage_backblazeb2_open();
 cloudstorage_backblazeb2_close($res);
 cloudstorage_backblazeb2_register_callback($res, $id, $function);
 cloudstorage_backblazeb2_get_last_error($res);
 cloudstorage_backblazeb2_get_last_error_code($res);
 cloudstorage_backblazeb2_set($res, $id, $index, $value);
 cloudstorage_backblazeb2_get($res, $id, $index);
 cloudstorage_backblazeb2_do_abortmultipartupload($res, $multipartfileid);
 cloudstorage_backblazeb2_do_addmetadata($res, $name, $value);
 cloudstorage_backblazeb2_do_addqueryparam($res, $name, $value);
 cloudstorage_backblazeb2_do_authorize($res);
 cloudstorage_backblazeb2_do_completemultipartupload($res, $multipartfileid);
 cloudstorage_backblazeb2_do_config($res, $configurationstring);
 cloudstorage_backblazeb2_do_copyfile($res, $srcfileid, $destbucketid, $destfilename);
 cloudstorage_backblazeb2_do_copypart($res, $srcfileid, $multipartfileid, $partnumber);
 cloudstorage_backblazeb2_do_createappkey($res, $keyname, $capabilities, $allowedbucketid, $allowedprefix, $validityduration);
 cloudstorage_backblazeb2_do_createbucket($res, $bucketname, $kind);
 cloudstorage_backblazeb2_do_deleteappkey($res, $keyid);
 cloudstorage_backblazeb2_do_deletebucket($res, $bucketid);
 cloudstorage_backblazeb2_do_deletefile($res, $bucketid, $filename);
 cloudstorage_backblazeb2_do_deletefileversion($res, $fileid);
 cloudstorage_backblazeb2_do_downloadfile($res, $bucketname, $filename);
 cloudstorage_backblazeb2_do_downloadfilebyid($res, $fileid);
 cloudstorage_backblazeb2_do_getbucketinfo($res, $bucketid);
 cloudstorage_backblazeb2_do_getdownloadauthtoken($res, $allowedbucketid, $allowedprefix, $validityduration);
 cloudstorage_backblazeb2_do_getfileinfo($res, $fileid);
 cloudstorage_backblazeb2_do_hidefile($res, $bucketid, $filename);
 cloudstorage_backblazeb2_do_interrupt($res);
 cloudstorage_backblazeb2_do_listappkeys($res);
 cloudstorage_backblazeb2_do_listbuckets($res);
 cloudstorage_backblazeb2_do_listfiles($res, $bucketid);
 cloudstorage_backblazeb2_do_listfileversions($res, $bucketid);
 cloudstorage_backblazeb2_do_listmultipartuploads($res, $bucketid);
 cloudstorage_backblazeb2_do_listparts($res, $multipartfileid);
 cloudstorage_backblazeb2_do_reset($res);
 cloudstorage_backblazeb2_do_sendcustomrequest($res, $httpmethod, $operation, $requestbody);
 cloudstorage_backblazeb2_do_startmultipartupload($res, $bucketid, $filename);
 cloudstorage_backblazeb2_do_updatebucket($res, $bucketid, $newkind, $newmetadata);
 cloudstorage_backblazeb2_do_uploadfile($res, $bucketid, $filename);
 cloudstorage_backblazeb2_do_uploadpart($res, $multipartfileid, $partnumber);

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:

• Bucket management: ListBuckets, GetBucketInfo, CreateBucket, UpdateBucket, DeleteBucket
• File management: ListFiles, ListFileVersions, GetFileInfo, UploadFile, CopyFile, DownloadFile, DownloadFileById, HideFile, DeleteFile, DeleteFileVersion
• Multipart uploads: ListMultipartUploads, StartMultipartUpload, CompleteMultipartUpload, AbortMultipartUpload, ListParts, UploadPart, CopyPart
• Application key management: ListAppKeys, CreateAppKey, DeleteAppKey
• Sharing files: GetDownloadAuthToken

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AccountId Property (CloudStorage_BackblazeB2 Class)

The Id of the account.

Object Oriented Interface

public function getAccountId();

Procedural Interface

cloudstorage_backblazeb2_get($res, 1 );

Default Value

''

Remarks

The Id of the account.

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

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

Data Type

String

AccountAllowedBucketId Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getAccountAllowedBucketId();

Procedural Interface

cloudstorage_backblazeb2_get($res, 2 );

Default Value

''

Remarks

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

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

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

Data Type

String

AccountAllowedBucketName Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getAccountAllowedBucketName();

Procedural Interface

cloudstorage_backblazeb2_get($res, 3 );

Default Value

''

Remarks

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

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

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

Data Type

String

AccountAllowedPrefix Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getAccountAllowedPrefix();

Procedural Interface

cloudstorage_backblazeb2_get($res, 4 );

Default Value

''

Remarks

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

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

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

Data Type

String

AccountAuthToken Property (CloudStorage_BackblazeB2 Class)

The authorization token that will be used to authorize requests.

Object Oriented Interface

public function getAccountAuthToken();

Procedural Interface

cloudstorage_backblazeb2_get($res, 5 );

Default Value

''

Remarks

The authorization token that will be used to authorize requests.

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

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

Data Type

String

AccountCapabilities Property (CloudStorage_BackblazeB2 Class)

The capabilities that the application key has.

Object Oriented Interface

public function getAccountCapabilities();

Procedural Interface

cloudstorage_backblazeb2_get($res, 6 );

Default Value

''

Remarks

The capabilities that the application key has.

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

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

Data Type

String

AccountMinPartSize Property (CloudStorage_BackblazeB2 Class)

The minimum allowed multipart upload part size.

Object Oriented Interface

public function getAccountMinPartSize();

Procedural Interface

cloudstorage_backblazeb2_get($res, 7 );

Default Value

-1

Remarks

The minimum allowed multipart upload part size.

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

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

Data Type

Long64

AccountRecPartSize Property (CloudStorage_BackblazeB2 Class)

The recommended multipart upload part size.

Object Oriented Interface

public function getAccountRecPartSize();

Procedural Interface

cloudstorage_backblazeb2_get($res, 8 );

Default Value

-1

Remarks

The recommended multipart upload part size.

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

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

Data Type

Long64

AppKeyMarker Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getAppKeyMarker();
public function setAppKeyMarker($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 9 );
cloudstorage_backblazeb2_set($res, 9, $value );

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.

Data Type

String

AppKeyCount Property (CloudStorage_BackblazeB2 Class)

The number of records in the AppKey arrays.

Object Oriented Interface

public function getAppKeyCount();

Procedural Interface

cloudstorage_backblazeb2_get($res, 10 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AppKeyAllowedBucketId
• AppKeyAllowedPrefix
• AppKeyCapabilities
• AppKeyExpirationTime
• AppKeyId
• AppKeyName

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

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

Data Type

Integer

AppKeyAllowedBucketId Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getAppKeyAllowedBucketId($appkeyindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 11 , $appkeyindex);

Default Value

''

Remarks

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

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

The $appkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the AppKeyCount property.

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

Data Type

String

AppKeyAllowedPrefix Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getAppKeyAllowedPrefix($appkeyindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 12 , $appkeyindex);

Default Value

''

Remarks

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

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

The $appkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the AppKeyCount property.

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

Data Type

String

AppKeyCapabilities Property (CloudStorage_BackblazeB2 Class)

The capabilities that the application key has.

Object Oriented Interface

public function getAppKeyCapabilities($appkeyindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 13 , $appkeyindex);

Default Value

''

Remarks

The capabilities that the application key has.

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

The $appkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the AppKeyCount property.

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

Data Type

String

AppKeyExpirationTime Property (CloudStorage_BackblazeB2 Class)

The application key's expiration time.

Object Oriented Interface

public function getAppKeyExpirationTime($appkeyindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 14 , $appkeyindex);

Default Value

-1

Remarks

The application key's expiration time.

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

The $appkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the AppKeyCount property.

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

Data Type

Long64

AppKeyId Property (CloudStorage_BackblazeB2 Class)

The Id of the application key.

Object Oriented Interface

public function getAppKeyId($appkeyindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 15 , $appkeyindex);

Default Value

''

Remarks

The Id of the application key.

This property reflects the unique Id of the application key.

The $appkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the AppKeyCount property.

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

Data Type

String

AppKeyName Property (CloudStorage_BackblazeB2 Class)

The name of the application key.

Object Oriented Interface

public function getAppKeyName($appkeyindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 16 , $appkeyindex);

Default Value

''

Remarks

The name of the application key.

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

The $appkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the AppKeyCount property.

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

Data Type

String

ApplicationKey Property (CloudStorage_BackblazeB2 Class)

The application key to use for authentication.

Object Oriented Interface

public function getApplicationKey();
public function setApplicationKey($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 17 );
cloudstorage_backblazeb2_set($res, 17, $value );

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.

Data Type

String

ApplicationKeyId Property (CloudStorage_BackblazeB2 Class)

The application key Id to use for authentication.

Object Oriented Interface

public function getApplicationKeyId();
public function setApplicationKeyId($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 18 );
cloudstorage_backblazeb2_set($res, 18, $value );

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.

Data Type

String

BucketCount Property (CloudStorage_BackblazeB2 Class)

The number of records in the Bucket arrays.

Object Oriented Interface

public function getBucketCount();

Procedural Interface

cloudstorage_backblazeb2_get($res, 19 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BucketId
• BucketKind
• BucketName
• BucketRevision

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

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

Data Type

Integer

BucketId Property (CloudStorage_BackblazeB2 Class)

The Id of the bucket.

Object Oriented Interface

public function getBucketId($bucketindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 20 , $bucketindex);

Default Value

''

Remarks

The Id of the bucket.

This property reflects the unique Id of the bucket.

The $bucketindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketCount property.

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

Data Type

String

BucketKind Property (CloudStorage_BackblazeB2 Class)

The kind of bucket.

Object Oriented Interface

public function getBucketKind($bucketindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 21 , $bucketindex);

Default Value

''

Remarks

The kind of bucket.

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

The $bucketindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketCount property.

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

Data Type

String

BucketName Property (CloudStorage_BackblazeB2 Class)

The name of the bucket.

Object Oriented Interface

public function getBucketName($bucketindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 22 , $bucketindex);

Default Value

''

Remarks

The name of the bucket.

This property reflects the name of the bucket.

The $bucketindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketCount property.

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

Data Type

String

BucketRevision Property (CloudStorage_BackblazeB2 Class)

The revision number of the bucket.

Object Oriented Interface

public function getBucketRevision($bucketindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 23 , $bucketindex);

Default Value

-1

Remarks

The revision number of the bucket.

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

The $bucketindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketCount property.

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

Data Type

Long64

ContentType Property (CloudStorage_BackblazeB2 Class)

The content type to send for a file.

Object Oriented Interface

public function getContentType();
public function setContentType($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 24 );
cloudstorage_backblazeb2_set($res, 24, $value );

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.

Data Type

String

Delimiter Property (CloudStorage_BackblazeB2 Class)

The delimiter string to use when listing files.

Object Oriented Interface

public function getDelimiter();
public function setDelimiter($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 25 );
cloudstorage_backblazeb2_set($res, 25, $value );

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

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (CloudStorage_BackblazeB2 Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 26 );
cloudstorage_backblazeb2_set($res, 26, $value );

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:

Data Type

Integer

EncryptionPassword Property (CloudStorage_BackblazeB2 Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 27 );
cloudstorage_backblazeb2_set($res, 27, $value );

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.

Data Type

String

FileData Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getFileData();
public function setFileData($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 28 );
cloudstorage_backblazeb2_set($res, 28, $value );

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.

Data Type

Binary String

FileMarker Property (CloudStorage_BackblazeB2 Class)

A marker indicating what page of files to return next.

Object Oriented Interface

public function getFileMarker();
public function setFileMarker($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 29 );
cloudstorage_backblazeb2_set($res, 29, $value );

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.

Data Type

String

FileCount Property (CloudStorage_BackblazeB2 Class)

The number of records in the File arrays.

Object Oriented Interface

public function getFileCount();

Procedural Interface

cloudstorage_backblazeb2_get($res, 30 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• FileBucketId
• FileContentType
• FileCreatedTime
• FileId
• FileKind
• FileMD5Hash
• FileModifiedTime
• FileName
• FileSHA1Hash
• FileSize

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

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

Data Type

Integer

FileBucketId Property (CloudStorage_BackblazeB2 Class)

The Id of the bucket that the file is in.

Object Oriented Interface

public function getFileBucketId($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 31 , $fileindex);

Default Value

''

Remarks

The Id of the bucket that the file is in.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

String

FileContentType Property (CloudStorage_BackblazeB2 Class)

The content type of the file.

Object Oriented Interface

public function getFileContentType($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 32 , $fileindex);

Default Value

''

Remarks

The content type of the file.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

String

FileCreatedTime Property (CloudStorage_BackblazeB2 Class)

The file's creation time.

Object Oriented Interface

public function getFileCreatedTime($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 33 , $fileindex);

Default Value

-1

Remarks

The file's creation time.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

Long64

FileId Property (CloudStorage_BackblazeB2 Class)

The Id of the file.

Object Oriented Interface

public function getFileId($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 34 , $fileindex);

Default Value

''

Remarks

The Id of the file.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

String

FileKind Property (CloudStorage_BackblazeB2 Class)

The kind of file.

Object Oriented Interface

public function getFileKind($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 35 , $fileindex);

Default Value

''

Remarks

The kind of file.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

String

FileMD5Hash Property (CloudStorage_BackblazeB2 Class)

An MD5 hash of the file's contents.

Object Oriented Interface

public function getFileMD5Hash($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 36 , $fileindex);

Default Value

''

Remarks

An MD5 hash of the file's contents.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

String

FileModifiedTime Property (CloudStorage_BackblazeB2 Class)

The file's last modified time.

Object Oriented Interface

public function getFileModifiedTime($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 37 , $fileindex);

Default Value

-1

Remarks

The file's last modified time.

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

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

Long64

FileName Property (CloudStorage_BackblazeB2 Class)

The name of the file.

Object Oriented Interface

public function getFileName($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 38 , $fileindex);

Default Value

''

Remarks

The name of the file.

This property reflects the name of the file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

String

FileSHA1Hash Property (CloudStorage_BackblazeB2 Class)

A SHA1 hash of the file's contents.

Object Oriented Interface

public function getFileSHA1Hash($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 39 , $fileindex);

Default Value

''

Remarks

A SHA1 hash of the file's contents.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

String

FileSize Property (CloudStorage_BackblazeB2 Class)

The file's size.

Object Oriented Interface

public function getFileSize($fileindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 40 , $fileindex);

Default Value

0

Remarks

The file's size.

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

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

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

Data Type

Long64

FirewallAutoDetect Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 41 );
cloudstorage_backblazeb2_set($res, 41, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudStorage_BackblazeB2 Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 42 );
cloudstorage_backblazeb2_set($res, 42, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_BackblazeB2 Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 43 );
cloudstorage_backblazeb2_set($res, 43, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (CloudStorage_BackblazeB2 Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 44 );
cloudstorage_backblazeb2_set($res, 44, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (CloudStorage_BackblazeB2 Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 45 );
cloudstorage_backblazeb2_set($res, 45, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (CloudStorage_BackblazeB2 Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 46 );
cloudstorage_backblazeb2_set($res, 46, $value );

Default Value

''

Remarks

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

Data Type

String

Idle Property (CloudStorage_BackblazeB2 Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_backblazeb2_get($res, 47 );

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.

Data Type

Boolean

LocalFile Property (CloudStorage_BackblazeB2 Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 48 );
cloudstorage_backblazeb2_set($res, 48, $value );

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.

Data Type

String

LocalHost Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 49 );
cloudstorage_backblazeb2_set($res, 49, $value );

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.

Data Type

String

MetadataCount Property (CloudStorage_BackblazeB2 Class)

The number of records in the Metadata arrays.

Object Oriented Interface

public function getMetadataCount();
public function setMetadataCount($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 50 );
cloudstorage_backblazeb2_set($res, 50, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

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

This property is not available at design time.

Data Type

Integer

MetadataName Property (CloudStorage_BackblazeB2 Class)

The name of the metadata item.

Object Oriented Interface

public function getMetadataName($metadataindex);
public function setMetadataName($metadataindex, $value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 51 , $metadataindex);
cloudstorage_backblazeb2_set($res, 51, $value , $metadataindex);

Default Value

''

Remarks

The name of the metadata item.

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

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

The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

MetadataValue Property (CloudStorage_BackblazeB2 Class)

The value of the metadata item.

Object Oriented Interface

public function getMetadataValue($metadataindex);
public function setMetadataValue($metadataindex, $value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 52 , $metadataindex);
cloudstorage_backblazeb2_set($res, 52, $value , $metadataindex);

Default Value

''

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

OtherHeaders Property (CloudStorage_BackblazeB2 Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 53 );
cloudstorage_backblazeb2_set($res, 53, $value );

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 CRLF ("\r\n") .

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

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

This property is not available at design time.

Data Type

String

Overwrite Property (CloudStorage_BackblazeB2 Class)

Determines if local files are overwritten.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 54 );
cloudstorage_backblazeb2_set($res, 54, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_BackblazeB2 Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_backblazeb2_get($res, 55 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 56 , $parsedheaderindex);

Default Value

''

Remarks

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

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (CloudStorage_BackblazeB2 Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 57 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

PartMarker Property (CloudStorage_BackblazeB2 Class)

A marker indicating what page of parts to return next.

Object Oriented Interface

public function getPartMarker();
public function setPartMarker($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 58 );
cloudstorage_backblazeb2_set($res, 58, $value );

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.

Data Type

String

PartCount Property (CloudStorage_BackblazeB2 Class)

The number of records in the Part arrays.

Object Oriented Interface

public function getPartCount();

Procedural Interface

cloudstorage_backblazeb2_get($res, 59 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartCreatedTime
• PartMD5Hash
• PartNumber
• PartSHA1Hash
• PartSize

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

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

Data Type

Integer

PartCreatedTime Property (CloudStorage_BackblazeB2 Class)

The part's creation time.

Object Oriented Interface

public function getPartCreatedTime($partindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 60 , $partindex);

Default Value

-1

Remarks

The part's creation time.

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

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

Long64

PartMD5Hash Property (CloudStorage_BackblazeB2 Class)

An MD5 hash of the part's contents.

Object Oriented Interface

public function getPartMD5Hash($partindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 61 , $partindex);

Default Value

''

Remarks

An MD5 hash of the part's contents.

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

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

String

PartNumber Property (CloudStorage_BackblazeB2 Class)

The number of the part.

Object Oriented Interface

public function getPartNumber($partindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 62 , $partindex);

Default Value

-1

Remarks

The number of the part.

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

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

Integer

PartSHA1Hash Property (CloudStorage_BackblazeB2 Class)

A SHA1 hash of the part's contents.

Object Oriented Interface

public function getPartSHA1Hash($partindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 63 , $partindex);

Default Value

''

Remarks

A SHA1 hash of the part's contents.

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

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

String

PartSize Property (CloudStorage_BackblazeB2 Class)

The part's size.

Object Oriented Interface

public function getPartSize($partindex);

Procedural Interface

cloudstorage_backblazeb2_get($res, 64 , $partindex);

Default Value

0

Remarks

The part's size.

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

The $partindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

Long64

Prefix Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getPrefix();
public function setPrefix($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 65 );
cloudstorage_backblazeb2_set($res, 65, $value );

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:

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (CloudStorage_BackblazeB2 Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 66 );
cloudstorage_backblazeb2_set($res, 66, $value );

Default Value

0

Remarks

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 67 );
cloudstorage_backblazeb2_set($res, 67, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 68 );
cloudstorage_backblazeb2_set($res, 68, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (CloudStorage_BackblazeB2 Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 69 );
cloudstorage_backblazeb2_set($res, 69, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 70 );
cloudstorage_backblazeb2_set($res, 70, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (CloudStorage_BackblazeB2 Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 71 );
cloudstorage_backblazeb2_set($res, 71, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 72 );
cloudstorage_backblazeb2_set($res, 72, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

QueryParamCount Property (CloudStorage_BackblazeB2 Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 73 );
cloudstorage_backblazeb2_set($res, 73, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

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

This property is not available at design time.

Data Type

Integer

QueryParamName Property (CloudStorage_BackblazeB2 Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 74 , $queryparamindex);
cloudstorage_backblazeb2_set($res, 74, $value , $queryparamindex);

Default Value

''

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (CloudStorage_BackblazeB2 Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 75 , $queryparamindex);
cloudstorage_backblazeb2_set($res, 75, $value , $queryparamindex);

Default Value

''

Remarks

The value of the query parameter.

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

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

Range Property (CloudStorage_BackblazeB2 Class)

The range of bytes to request.

Object Oriented Interface

public function getRange();
public function setRange($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 76 );
cloudstorage_backblazeb2_set($res, 76, $value );

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.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudStorage_BackblazeB2 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_backblazeb2_get($res, 77 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudStorage_BackblazeB2 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_backblazeb2_get($res, 78 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_BackblazeB2 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_backblazeb2_get($res, 79 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_backblazeb2_get($res, 80 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_backblazeb2_get($res, 81 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_backblazeb2_get($res, 82 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudStorage_BackblazeB2 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_backblazeb2_get($res, 83 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudStorage_BackblazeB2 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_backblazeb2_get($res, 84 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudStorage_BackblazeB2 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_backblazeb2_get($res, 85 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudStorage_BackblazeB2 Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_backblazeb2_get($res, 86 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudStorage_BackblazeB2 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_backblazeb2_get($res, 87 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudStorage_BackblazeB2 Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_backblazeb2_get($res, 88 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudStorage_BackblazeB2 Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_backblazeb2_get($res, 89 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudStorage_BackblazeB2 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_backblazeb2_get($res, 90 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudStorage_BackblazeB2 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_backblazeb2_get($res, 91 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudStorage_BackblazeB2 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 92 );
cloudstorage_backblazeb2_set($res, 92, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 93 );
cloudstorage_backblazeb2_set($res, 93, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (CloudStorage_BackblazeB2 Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 94 );
cloudstorage_backblazeb2_set($res, 94, $value );

Default Value

0

Remarks

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:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_backblazeb2_get($res, 95 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_BackblazeB2 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_backblazeb2_get($res, 96 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudStorage_BackblazeB2 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_backblazeb2_get($res, 97 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudStorage_BackblazeB2 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_backblazeb2_get($res, 98 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudStorage_BackblazeB2 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_backblazeb2_get($res, 99 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudStorage_BackblazeB2 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_backblazeb2_get($res, 100 );

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudStorage_BackblazeB2 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_backblazeb2_get($res, 101 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudStorage_BackblazeB2 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 102 );
cloudstorage_backblazeb2_set($res, 102, $value );

Default Value

''

Remarks

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:

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

Data Type

String

SSLAcceptServerCertEncoded Property (CloudStorage_BackblazeB2 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 103 );
cloudstorage_backblazeb2_set($res, 103, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudStorage_BackblazeB2 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_backblazeb2_get($res, 104 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudStorage_BackblazeB2 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_backblazeb2_get($res, 105 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudStorage_BackblazeB2 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_backblazeb2_get($res, 106 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_backblazeb2_get($res, 107 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_backblazeb2_get($res, 108 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_backblazeb2_get($res, 109 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudStorage_BackblazeB2 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_backblazeb2_get($res, 110 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudStorage_BackblazeB2 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_backblazeb2_get($res, 111 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudStorage_BackblazeB2 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_backblazeb2_get($res, 112 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudStorage_BackblazeB2 Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_backblazeb2_get($res, 113 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudStorage_BackblazeB2 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_backblazeb2_get($res, 114 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudStorage_BackblazeB2 Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_backblazeb2_get($res, 115 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudStorage_BackblazeB2 Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_backblazeb2_get($res, 116 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudStorage_BackblazeB2 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_backblazeb2_get($res, 117 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudStorage_BackblazeB2 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_backblazeb2_get($res, 118 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudStorage_BackblazeB2 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 119 );
cloudstorage_backblazeb2_set($res, 119, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 120 );
cloudstorage_backblazeb2_set($res, 120, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (CloudStorage_BackblazeB2 Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 121 );
cloudstorage_backblazeb2_set($res, 121, $value );

Default Value

0

Remarks

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:

Data Type

Integer

SSLCertSubjectAltNames Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_backblazeb2_get($res, 122 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_BackblazeB2 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_backblazeb2_get($res, 123 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudStorage_BackblazeB2 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_backblazeb2_get($res, 124 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudStorage_BackblazeB2 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_backblazeb2_get($res, 125 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudStorage_BackblazeB2 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_backblazeb2_get($res, 126 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudStorage_BackblazeB2 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_backblazeb2_get($res, 127 );

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudStorage_BackblazeB2 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_backblazeb2_get($res, 128 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudStorage_BackblazeB2 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 129 );
cloudstorage_backblazeb2_set($res, 129, $value );

Default Value

''

Remarks

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:

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

Data Type

String

SSLCertEncoded Property (CloudStorage_BackblazeB2 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 130 );
cloudstorage_backblazeb2_set($res, 130, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 131 );
cloudstorage_backblazeb2_set($res, 131, $value );

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:

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, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudStorage_BackblazeB2 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_backblazeb2_get($res, 132 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudStorage_BackblazeB2 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_backblazeb2_get($res, 133 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudStorage_BackblazeB2 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_backblazeb2_get($res, 134 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_backblazeb2_get($res, 135 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_backblazeb2_get($res, 136 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudStorage_BackblazeB2 Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_backblazeb2_get($res, 137 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudStorage_BackblazeB2 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_backblazeb2_get($res, 138 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudStorage_BackblazeB2 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_backblazeb2_get($res, 139 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudStorage_BackblazeB2 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_backblazeb2_get($res, 140 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudStorage_BackblazeB2 Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_backblazeb2_get($res, 141 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudStorage_BackblazeB2 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_backblazeb2_get($res, 142 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudStorage_BackblazeB2 Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_backblazeb2_get($res, 143 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudStorage_BackblazeB2 Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_backblazeb2_get($res, 144 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudStorage_BackblazeB2 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_backblazeb2_get($res, 145 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudStorage_BackblazeB2 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_backblazeb2_get($res, 146 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudStorage_BackblazeB2 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_backblazeb2_get($res, 147 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudstorage_backblazeb2_get($res, 148 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudStorage_BackblazeB2 Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_backblazeb2_get($res, 149 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_backblazeb2_get($res, 150 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_BackblazeB2 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_backblazeb2_get($res, 151 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudStorage_BackblazeB2 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_backblazeb2_get($res, 152 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudStorage_BackblazeB2 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_backblazeb2_get($res, 153 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudStorage_BackblazeB2 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudstorage_backblazeb2_get($res, 154 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudStorage_BackblazeB2 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudstorage_backblazeb2_get($res, 155 );

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudStorage_BackblazeB2 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudstorage_backblazeb2_get($res, 156 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudStorage_BackblazeB2 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudstorage_backblazeb2_get($res, 157 );

Default Value

''

Remarks

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:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudStorage_BackblazeB2 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_backblazeb2_get($res, 158 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

StartByte Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 159 );
cloudstorage_backblazeb2_set($res, 159, $value );

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.

Data Type

Long64

Timeout Property (CloudStorage_BackblazeB2 Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 160 );
cloudstorage_backblazeb2_set($res, 160, $value );

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 fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

VersionMarker Property (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function getVersionMarker();
public function setVersionMarker($value);

Procedural Interface

cloudstorage_backblazeb2_get($res, 161 );
cloudstorage_backblazeb2_set($res, 161, $value );

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.

Data Type

String

AbortMultipartUpload Method (CloudStorage_BackblazeB2 Class)

Aborts a multipart upload.

Object Oriented Interface

public function doAbortMultipartUpload($multipartfileid);

Procedural Interface

cloudstorage_backblazeb2_do_abortmultipartupload($res, $multipartfileid);

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.

AddMetadata Method (CloudStorage_BackblazeB2 Class)

Adds a metadata item to the Metadata properties.

Object Oriented Interface

public function doAddMetadata($name, $value);

Procedural Interface

cloudstorage_backblazeb2_do_addmetadata($res, $name, $value);

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.

AddQueryParam Method (CloudStorage_BackblazeB2 Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudstorage_backblazeb2_do_addqueryparam($res, $name, $value);

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.

Authorize Method (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudstorage_backblazeb2_do_authorize($res);

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.

CompleteMultipartUpload Method (CloudStorage_BackblazeB2 Class)

Completes a multipart upload by assembling the previously uploaded parts.

Object Oriented Interface

public function doCompleteMultipartUpload($multipartfileid);

Procedural Interface

cloudstorage_backblazeb2_do_completemultipartupload($res, $multipartfileid);

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.

Config Method (CloudStorage_BackblazeB2 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_backblazeb2_do_config($res, $configurationstring);

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.

CopyFile Method (CloudStorage_BackblazeB2 Class)

Copies a file.

Object Oriented Interface

public function doCopyFile($srcfileid, $destbucketid, $destfilename);

Procedural Interface

cloudstorage_backblazeb2_do_copyfile($res, $srcfileid, $destbucketid, $destfilename);

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.

CopyPart Method (CloudStorage_BackblazeB2 Class)

Copies the specified file as part of a multipart upload.

Object Oriented Interface

public function doCopyPart($srcfileid, $multipartfileid, $partnumber);

Procedural Interface

cloudstorage_backblazeb2_do_copypart($res, $srcfileid, $multipartfileid, $partnumber);

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.

CreateAppKey Method (CloudStorage_BackblazeB2 Class)

Creates a new application key.

Object Oriented Interface

public function doCreateAppKey($keyname, $capabilities, $allowedbucketid, $allowedprefix, $validityduration);

Procedural Interface

cloudstorage_backblazeb2_do_createappkey($res, $keyname, $capabilities, $allowedbucketid, $allowedprefix, $validityduration);

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.

CreateBucket Method (CloudStorage_BackblazeB2 Class)

Creates a new bucket.

Object Oriented Interface

public function doCreateBucket($bucketname, $kind);

Procedural Interface

cloudstorage_backblazeb2_do_createbucket($res, $bucketname, $kind);

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.

DeleteAppKey Method (CloudStorage_BackblazeB2 Class)

Deletes an application key.

Object Oriented Interface

public function doDeleteAppKey($keyid);

Procedural Interface

cloudstorage_backblazeb2_do_deleteappkey($res, $keyid);

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.

DeleteBucket Method (CloudStorage_BackblazeB2 Class)

Deletes a bucket.

Object Oriented Interface

public function doDeleteBucket($bucketid);

Procedural Interface

cloudstorage_backblazeb2_do_deletebucket($res, $bucketid);

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.

DeleteFile Method (CloudStorage_BackblazeB2 Class)

Deletes all versions of a file.

Object Oriented Interface

public function doDeleteFile($bucketid, $filename);

Procedural Interface

cloudstorage_backblazeb2_do_deletefile($res, $bucketid, $filename);

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.

DeleteFileVersion Method (CloudStorage_BackblazeB2 Class)

Deletes a file version.

Object Oriented Interface

public function doDeleteFileVersion($fileid);

Procedural Interface

cloudstorage_backblazeb2_do_deletefileversion($res, $fileid);

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.

DownloadFile Method (CloudStorage_BackblazeB2 Class)

Downloads a file by name.

Object Oriented Interface

public function doDownloadFile($bucketname, $filename);

Procedural Interface

cloudstorage_backblazeb2_do_downloadfile($res, $bucketname, $filename);

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.

DownloadFileById Method (CloudStorage_BackblazeB2 Class)

Downloads a file by Id.

Object Oriented Interface

public function doDownloadFileById($fileid);

Procedural Interface

cloudstorage_backblazeb2_do_downloadfilebyid($res, $fileid);

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.

GetBucketInfo Method (CloudStorage_BackblazeB2 Class)

Gets a bucket's information and metadata.

Object Oriented Interface

public function doGetBucketInfo($bucketid);

Procedural Interface

cloudstorage_backblazeb2_do_getbucketinfo($res, $bucketid);

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.

GetDownloadAuthToken Method (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function doGetDownloadAuthToken($allowedbucketid, $allowedprefix, $validityduration);

Procedural Interface

cloudstorage_backblazeb2_do_getdownloadauthtoken($res, $allowedbucketid, $allowedprefix, $validityduration);

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.

GetFileInfo Method (CloudStorage_BackblazeB2 Class)

Gets a file's information and metadata.

Object Oriented Interface

public function doGetFileInfo($fileid);

Procedural Interface

cloudstorage_backblazeb2_do_getfileinfo($res, $fileid);

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.

HideFile Method (CloudStorage_BackblazeB2 Class)

Hides a file.

Object Oriented Interface

public function doHideFile($bucketid, $filename);

Procedural Interface

cloudstorage_backblazeb2_do_hidefile($res, $bucketid, $filename);

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.

Interrupt Method (CloudStorage_BackblazeB2 Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_backblazeb2_do_interrupt($res);

Remarks

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

ListAppKeys Method (CloudStorage_BackblazeB2 Class)

Lists the account's application keys.

Object Oriented Interface

public function doListAppKeys();

Procedural Interface

cloudstorage_backblazeb2_do_listappkeys($res);

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.

ListBuckets Method (CloudStorage_BackblazeB2 Class)

Lists all buckets in the account.

Object Oriented Interface

public function doListBuckets();

Procedural Interface

cloudstorage_backblazeb2_do_listbuckets($res);

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.

ListFiles Method (CloudStorage_BackblazeB2 Class)

Lists the files in a bucket.

Object Oriented Interface

public function doListFiles($bucketid);

Procedural Interface

cloudstorage_backblazeb2_do_listfiles($res, $bucketid);

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:

ListFileVersions Method (CloudStorage_BackblazeB2 Class)

Lists the file versions in a bucket.

Object Oriented Interface

public function doListFileVersions($bucketid);

Procedural Interface

cloudstorage_backblazeb2_do_listfileversions($res, $bucketid);

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:

ListMultipartUploads Method (CloudStorage_BackblazeB2 Class)

Lists the in-progress multipart uploads in a bucket.

Object Oriented Interface

public function doListMultipartUploads($bucketid);

Procedural Interface

cloudstorage_backblazeb2_do_listmultipartuploads($res, $bucketid);

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.

ListParts Method (CloudStorage_BackblazeB2 Class)

Lists a multipart upload's parts.

Object Oriented Interface

public function doListParts($multipartfileid);

Procedural Interface

cloudstorage_backblazeb2_do_listparts($res, $multipartfileid);

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.

Reset Method (CloudStorage_BackblazeB2 Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_backblazeb2_do_reset($res);

Remarks

This method resets the class to its initial state.

SendCustomRequest Method (CloudStorage_BackblazeB2 Class)

Sends a custom request to the Backblaze B2 API.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $operation, $requestbody);

Procedural Interface

cloudstorage_backblazeb2_do_sendcustomrequest($res, $httpmethod, $operation, $requestbody);

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.

StartMultipartUpload Method (CloudStorage_BackblazeB2 Class)

Starts a new multipart upload.

Object Oriented Interface

public function doStartMultipartUpload($bucketid, $filename);

Procedural Interface

cloudstorage_backblazeb2_do_startmultipartupload($res, $bucketid, $filename);

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:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

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.

UpdateBucket Method (CloudStorage_BackblazeB2 Class)

Updates a bucket's kind and/or metadata.

Object Oriented Interface

public function doUpdateBucket($bucketid, $newkind, $newmetadata);

Procedural Interface

cloudstorage_backblazeb2_do_updatebucket($res, $bucketid, $newkind, $newmetadata);

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.

UploadFile Method (CloudStorage_BackblazeB2 Class)

Uploads a file.

Object Oriented Interface

public function doUploadFile($bucketid, $filename);

Procedural Interface

cloudstorage_backblazeb2_do_uploadfile($res, $bucketid, $filename);

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.

UploadPart Method (CloudStorage_BackblazeB2 Class)

Uploads a multipart upload part.

Object Oriented Interface

public function doUploadPart($multipartfileid, $partnumber);

Procedural Interface

cloudstorage_backblazeb2_do_uploadpart($res, $multipartfileid, $partnumber);

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.

AppKeyList Event (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function fireAppKeyList($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 1, array($this, 'fireAppKeyList'));

Parameter List

 'keyid'
 'keyname'
 'capabilities'
 'allowedbucketid'
 'allowedprefix'
 'expirationtime'

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.

BucketList Event (CloudStorage_BackblazeB2 Class)

Fires once for each bucket returned when listing buckets.

Object Oriented Interface

public function fireBucketList($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 2, array($this, 'fireBucketList'));

Parameter List

 'id'
 'name'
 'kind'
 'revision'

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.

EndTransfer Event (CloudStorage_BackblazeB2 Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 3, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

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.

Error Event (CloudStorage_BackblazeB2 Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 4, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

FileList Event (CloudStorage_BackblazeB2 Class)

Fires once for each file returned when listing files.

Object Oriented Interface

public function fireFileList($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 5, array($this, 'fireFileList'));

Parameter List

 'id'
 'name'
 'bucketid'
 'size'
 'contenttype'
 'createdtime'
 'modifiedtime'
 'kind'
 'sha1hash'

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:

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.

FragmentComplete Event (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 6, array($this, 'fireFragmentComplete'));

Parameter List

 'fragmentnumber'
 'fragmentcount'
 'interrupt'

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.

Header Event (CloudStorage_BackblazeB2 Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 7, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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

Log Event (CloudStorage_BackblazeB2 Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 8, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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:

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"

MetadataList Event (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function fireMetadataList($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 9, array($this, 'fireMetadataList'));

Parameter List

 'bucketid'
 'fileid'
 'name'
 'value'

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.

PartList Event (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function firePartList($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 10, array($this, 'firePartList'));

Parameter List

 'partnumber'
 'multipartfileid'
 'size'
 'createdtime'
 'sha1hash'

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.

Progress Event (CloudStorage_BackblazeB2 Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 11, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

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.

SSLServerAuthentication Event (CloudStorage_BackblazeB2 Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 12, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (CloudStorage_BackblazeB2 Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 13, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (CloudStorage_BackblazeB2 Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 14, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

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.

Transfer Event (CloudStorage_BackblazeB2 Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_backblazeb2_register_callback($res, 15, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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.

Config Settings (BackblazeB2 Class)

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

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (BackblazeB2 Class)

Common Errors

BackblazeB2 Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors