Class BackupClient`Experimental`

High-level Computer Backup API client for listing and deleting backup records.

The client uses Partner authorization and the backupApiUrl returned by authorizePartner. The target account must belong to a group with Enterprise Controls enabled, and the caller must be a group admin. Deleting a backup also requires the Enterprise Controls setting that permits admins to delete member backups.

Example

const backup = new BackupClient({
  masterKeyId: process.env.B2_MASTER_KEY_ID,
  masterKey: process.env.B2_MASTER_KEY,
})
await backup.authorize()
for await (const computer of backup.paginateComputers()) {
  console.log(computer.computerName)
}

Computer Backup API surface; shape may change as the Backup API docs evolve.

Index

Constructors

constructor

new BackupClient(options: BackupClientOptions): BackupClient
Experimental
Creates a new BackupClient. Call authorize before making API requests unless partnerAccountInfo already contains valid Partner authorization.
Parameters
- options: BackupClientOptions
  Configuration including credentials, realm, and transport settings.
Returns BackupClient
- Defined in backup/client.ts:237

Properties

`Readonly` `Experimental`partnerAccountInfo

partnerAccountInfo: PartnerAccountInfo

Partner authorization state storage (tokens, URLs, capabilities).

`Readonly` `Experimental`raw

raw: BackupRawClient

Low-level client for direct Computer Backup API calls.

`Readonly` `Experimental`urlGuard

urlGuard: UrlGuard | null

SSRF allow-list applied by the default transport. null when a custom transport was supplied; in that case the SDK does not own the guard.

Methods

authorize

authorize(options?: BackupAuthorizeOptions): Promise<PartnerAuthorizeResponse>
Experimental
Authenticates with B2 Partner authorization and stores the authorization state.
Parameters
- Optionaloptions: BackupAuthorizeOptions
  Optional abort signal.
Returns Promise<PartnerAuthorizeResponse>
The Partner authorization response containing tokens, URLs, and capabilities.

Computer Backup API surface; shape may change as the Backup API docs evolve.
- Defined in backup/client.ts:258

deleteComputer

deleteComputer(options: DeleteComputerOptions): Promise<DeleteComputerResponse>
Experimental
Deletes a Computer Backup record.

This destructive mutation is not automatically retried or reauthorized in place; callers should reconcile backup state before issuing a new delete after an ambiguous failure.
Parameters
- options: DeleteComputerOptions
  Target account, computer ID, and optional abort signal.
Returns Promise<DeleteComputerResponse>
The deleted computer backup record array.

Computer Backup API surface; shape may change as the Backup API docs evolve.
- Defined in backup/client.ts:329

listComputers

listComputers(options?: ListComputersOptions): Promise<ListComputersResult>
Experimental
Lists active Computer Backup records for an account.
Parameters
- Optionaloptions: ListComputersOptions
  Optional target account and pagination settings.
Returns Promise<ListComputersResult>
A normalized page of computer backup records with an optional continuation cursor.

Computer Backup API surface; shape may change as the Backup API docs evolve.
- Defined in backup/client.ts:273

paginateComputers

paginateComputers(
options?: PaginateComputersOptions,
): AsyncIterableIterator<ComputerBackup>
Experimental
Async iterator that yields every active Computer Backup record for an account.
Parameters
- Optionaloptions: PaginateComputersOptions
  Optional target account, page size, and abort signal.
Returns AsyncIterableIterator<ComputerBackup>
An async iterable of ComputerBackup entries.

Computer Backup API surface; shape may change as the Backup API docs evolve.
- Defined in backup/client.ts:300

toJSON

toJSON(): BackupClientJson
Experimental
Hides credentials and Partner tokens from JSON.stringify(client).

Returns BackupClientJson
A redacted diagnostic object.
- Defined in backup/client.ts:375

toString

toString(): string
Experimental
Hides credentials and Partner tokens from default stringification.

Returns string
A short redacted label.
- Defined in backup/client.ts:391

Class BackupClient`Experimental`

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BackupClient

Properties

`Readonly` `Experimental`partnerAccountInfo

`Readonly` `Experimental`raw

`Readonly` `Experimental`urlGuard

Methods

authorize

Parameters

Returns Promise<PartnerAuthorizeResponse>

deleteComputer

Parameters

Returns Promise<DeleteComputerResponse>

listComputers

Parameters

Returns Promise<ListComputersResult>

paginateComputers

Parameters

Returns AsyncIterableIterator<ComputerBackup>

toJSON

Returns BackupClientJson

toString

Returns string

Settings

On This Page

Class BackupClientExperimental

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BackupClient

Properties

Readonly ExperimentalpartnerAccountInfo

Readonly Experimentalraw

Readonly ExperimentalurlGuard

Methods

authorize

Parameters

Returns Promise<PartnerAuthorizeResponse>

deleteComputer

Parameters

Returns Promise<DeleteComputerResponse>

listComputers

Parameters

Returns Promise<ListComputersResult>

paginateComputers

Parameters

Returns AsyncIterableIterator<ComputerBackup>

toJSON

Returns BackupClientJson

toString

Returns string

Settings

On This Page

Class BackupClient`Experimental`

`Readonly` `Experimental`partnerAccountInfo

`Readonly` `Experimental`raw

`Readonly` `Experimental`urlGuard