IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

AppKeyList Event

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

Syntax

backblazeb2.on('AppKeyList', [callback])

Callback

The 'callback' is called when the 'AppKeyList' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.keyId
e.keyName
e.capabilities
e.allowedBucketId
e.allowedPrefix
e.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:

Capability String Related Methods
deleteBuckets DeleteBucket
deleteFiles DeleteFile, DeleteFileVersion
deleteKeys DeleteAppKey
listBuckets GetBucketInfo, ListBuckets
listFiles DeleteFile, ListFiles, ListFileVersions, ListMultipartUploads
listKeys ListAppKeys
readFiles CopyFile, CopyPart, DownloadFile, DownloadFileById, GetFileInfo
shareFiles GetDownloadAuthToken
writeBuckets CreateBucket, UpdateBucket
writeFiles AbortMultipartUpload, CompleteMultipartUpload, CopyFile, CopyPart, HideFile, ListParts, StartMultipartUpload, UploadFile, UploadPart
writeKeys CreateAppKey

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.

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