IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

ListBuckets Method

Lists all buckets in the account.

Syntax

backblazeb2.listBuckets([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]