IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

ListAppKeys Method

Lists the account's application keys.

Syntax

backblazeb2.listAppKeys([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 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 AppKey* 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 AppKey* properties.

The MaxAppKeyResults configuration setting can be used to control the maximum number of results returned each time this method is called.

The currently-authenticated application key must have the listKeys capability to call this method successfully, otherwise the server will return an error. Refer to the 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]