Variable Capability`Const`

Capability: {
    BypassGovernance: "bypassGovernance";
    DeleteBuckets: "deleteBuckets";
    DeleteFiles: "deleteFiles";
    DeleteKeys: "deleteKeys";
    ListAllBucketNames: "listAllBucketNames";
    ListBuckets: "listBuckets";
    ListFiles: "listFiles";
    ListKeys: "listKeys";
    ReadBucketEncryption: "readBucketEncryption";
    ReadBucketNotifications: "readBucketNotifications";
    ReadBucketReplications: "readBucketReplications";
    ReadBucketRetentions: "readBucketRetentions";
    ReadBuckets: "readBuckets";
    ReadFileLegalHolds: "readFileLegalHolds";
    ReadFileRetentions: "readFileRetentions";
    ReadFiles: "readFiles";
    ShareFiles: "shareFiles";
    WriteBucketEncryption: "writeBucketEncryption";
    WriteBucketNotifications: "writeBucketNotifications";
    WriteBucketReplications: "writeBucketReplications";
    WriteBucketRetentions: "writeBucketRetentions";
    WriteBuckets: "writeBuckets";
    WriteFileLegalHolds: "writeFileLegalHolds";
    WriteFileRetentions: "writeFileRetentions";
    WriteFiles: "writeFiles";
    WriteKeys: "writeKeys";
} = ...

Named constants for the B2 API capabilities that can be granted to an application key. Each capability controls access to a specific set of API operations.

Use these when constructing the capabilities array for an application key request, or when checking required capabilities via B2Client.hasCapabilities.

Type Declaration

ReadonlyBypassGovernance: "bypassGovernance"
Shorten governance-mode retention.
ReadonlyDeleteBuckets: "deleteBuckets"
Remove existing buckets from the account.
ReadonlyDeleteFiles: "deleteFiles"
Delete file versions.
ReadonlyDeleteKeys: "deleteKeys"
Delete application keys.
ReadonlyListAllBucketNames: "listAllBucketNames"
List bucket names without other metadata.
ReadonlyListBuckets: "listBuckets"
List buckets (subject to key restrictions).
ReadonlyListFiles: "listFiles"
List file names and versions.
ReadonlyListKeys: "listKeys"
List application keys.
ReadonlyReadBucketEncryption: "readBucketEncryption"
Read default bucket encryption settings.
ReadonlyReadBucketNotifications: "readBucketNotifications"
Read bucket event-notification rules.
ReadonlyReadBucketReplications: "readBucketReplications"
Read bucket replication configuration.
ReadonlyReadBucketRetentions: "readBucketRetentions"
Read bucket-level Object Lock retention settings.
ReadonlyReadBuckets: "readBuckets"
Read bucket settings.
ReadonlyReadFileLegalHolds: "readFileLegalHolds"
Read per-file legal hold flags.
ReadonlyReadFileRetentions: "readFileRetentions"
Read per-file Object Lock retention settings.
ReadonlyReadFiles: "readFiles"
Download files.
ReadonlyShareFiles: "shareFiles"
Mint download authorisation tokens.
ReadonlyWriteBucketEncryption: "writeBucketEncryption"
Modify default bucket encryption settings.
ReadonlyWriteBucketNotifications: "writeBucketNotifications"
Modify bucket event-notification rules.
ReadonlyWriteBucketReplications: "writeBucketReplications"
Modify bucket replication configuration.
ReadonlyWriteBucketRetentions: "writeBucketRetentions"
Modify bucket-level Object Lock retention settings.
ReadonlyWriteBuckets: "writeBuckets"
Create and update buckets.
ReadonlyWriteFileLegalHolds: "writeFileLegalHolds"
Modify per-file legal hold flags.
ReadonlyWriteFileRetentions: "writeFileRetentions"
Modify per-file Object Lock retention settings.
ReadonlyWriteFiles: "writeFiles"
Upload files.
ReadonlyWriteKeys: "writeKeys"
Create new application keys.

Example

const check = client.hasCapabilities([Capability.WriteFiles, Capability.ReadFiles])
if (!check.ok) throw new Error(`missing: ${check.missing.join(', ')}`)

Variable Capability`Const`

Type Declaration

`Readonly`BypassGovernance: "bypassGovernance"

`Readonly`DeleteBuckets: "deleteBuckets"

`Readonly`DeleteFiles: "deleteFiles"

`Readonly`DeleteKeys: "deleteKeys"

`Readonly`ListAllBucketNames: "listAllBucketNames"

`Readonly`ListBuckets: "listBuckets"

`Readonly`ListFiles: "listFiles"

`Readonly`ListKeys: "listKeys"

`Readonly`ReadBucketEncryption: "readBucketEncryption"

`Readonly`ReadBucketNotifications: "readBucketNotifications"

`Readonly`ReadBucketReplications: "readBucketReplications"

`Readonly`ReadBucketRetentions: "readBucketRetentions"

`Readonly`ReadBuckets: "readBuckets"

`Readonly`ReadFileLegalHolds: "readFileLegalHolds"

`Readonly`ReadFileRetentions: "readFileRetentions"

`Readonly`ReadFiles: "readFiles"

`Readonly`ShareFiles: "shareFiles"

`Readonly`WriteBucketEncryption: "writeBucketEncryption"

`Readonly`WriteBucketNotifications: "writeBucketNotifications"

`Readonly`WriteBucketReplications: "writeBucketReplications"

`Readonly`WriteBucketRetentions: "writeBucketRetentions"

`Readonly`WriteBuckets: "writeBuckets"

`Readonly`WriteFileLegalHolds: "writeFileLegalHolds"

`Readonly`WriteFileRetentions: "writeFileRetentions"

`Readonly`WriteFiles: "writeFiles"

`Readonly`WriteKeys: "writeKeys"

Example

Settings

Variable CapabilityConst

Type Declaration

ReadonlyBypassGovernance: "bypassGovernance"

ReadonlyDeleteBuckets: "deleteBuckets"

ReadonlyDeleteFiles: "deleteFiles"

ReadonlyDeleteKeys: "deleteKeys"

ReadonlyListAllBucketNames: "listAllBucketNames"

ReadonlyListBuckets: "listBuckets"

ReadonlyListFiles: "listFiles"

ReadonlyListKeys: "listKeys"

ReadonlyReadBucketEncryption: "readBucketEncryption"

ReadonlyReadBucketNotifications: "readBucketNotifications"

ReadonlyReadBucketReplications: "readBucketReplications"

ReadonlyReadBucketRetentions: "readBucketRetentions"

ReadonlyReadBuckets: "readBuckets"

ReadonlyReadFileLegalHolds: "readFileLegalHolds"

ReadonlyReadFileRetentions: "readFileRetentions"

ReadonlyReadFiles: "readFiles"

ReadonlyShareFiles: "shareFiles"

ReadonlyWriteBucketEncryption: "writeBucketEncryption"

ReadonlyWriteBucketNotifications: "writeBucketNotifications"

ReadonlyWriteBucketReplications: "writeBucketReplications"

ReadonlyWriteBucketRetentions: "writeBucketRetentions"

ReadonlyWriteBuckets: "writeBuckets"

ReadonlyWriteFileLegalHolds: "writeFileLegalHolds"

ReadonlyWriteFileRetentions: "writeFileRetentions"

ReadonlyWriteFiles: "writeFiles"

ReadonlyWriteKeys: "writeKeys"

Example

Settings

Variable Capability`Const`

`Readonly`BypassGovernance: "bypassGovernance"

`Readonly`DeleteBuckets: "deleteBuckets"

`Readonly`DeleteFiles: "deleteFiles"

`Readonly`DeleteKeys: "deleteKeys"

`Readonly`ListAllBucketNames: "listAllBucketNames"

`Readonly`ListBuckets: "listBuckets"

`Readonly`ListFiles: "listFiles"

`Readonly`ListKeys: "listKeys"

`Readonly`ReadBucketEncryption: "readBucketEncryption"

`Readonly`ReadBucketNotifications: "readBucketNotifications"

`Readonly`ReadBucketReplications: "readBucketReplications"

`Readonly`ReadBucketRetentions: "readBucketRetentions"

`Readonly`ReadBuckets: "readBuckets"

`Readonly`ReadFileLegalHolds: "readFileLegalHolds"

`Readonly`ReadFileRetentions: "readFileRetentions"

`Readonly`ReadFiles: "readFiles"

`Readonly`ShareFiles: "shareFiles"

`Readonly`WriteBucketEncryption: "writeBucketEncryption"

`Readonly`WriteBucketNotifications: "writeBucketNotifications"

`Readonly`WriteBucketReplications: "writeBucketReplications"

`Readonly`WriteBucketRetentions: "writeBucketRetentions"

`Readonly`WriteBuckets: "writeBuckets"

`Readonly`WriteFileLegalHolds: "writeFileLegalHolds"

`Readonly`WriteFileRetentions: "writeFileRetentions"

`Readonly`WriteFiles: "writeFiles"

`Readonly`WriteKeys: "writeKeys"