Home > @influxdata/influxdb-client-apis > BackupAPI

BackupAPI class

Backup API

Signature:

declare class BackupAPI 

Constructors

Constructor	Modifiers	Description
(constructor)(influxDB)		Creates BackupAPI

Methods

Method	Modifiers	Description
getBackupKV(request, requestOptions)		Download snapshot of metadata stored in the server’s embedded KV store. Don’t use with InfluxDB versions greater than InfluxDB 2.1.x. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBackupKV
getBackupMetadata(request, requestOptions)		Download snapshot of all metadata in the server. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBackupMetadata
getBackupShardId(request, requestOptions)		Download snapshot of all TSM data in a shard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBackupShardId