Documentation

influx restore

Available with InfluxDB OSS 2.x only

The influx restore command works with InfluxDB OSS 2.x, but does not work with InfluxDB Cloud. For information about restoring data in InfluxDB Cloud, see InfluxDB Cloud durabilty and contact InfluxData Support.

The influx restore command restores backup data and metadata from an InfluxDB OSS backup directory.

The restore process

When restoring data from a backup file set, InfluxDB temporarily moves existing data and metadata while restore runs. After restore completes, the temporary data is deleted. If the restore process fails, InfluxDB preserves the data in the temporary location.

For information about recovering from a failed restore process, see Restore data.

Usage

influx restore [flags]

Flags

Flag Description Input type Maps to ?
-c --active-config CLI configuration to use for command string
-b --bucket Name of the bucket to restore (mutually exclusive with --bucket-id) string
--bucket-id ID of the bucket to restore (mutually exclusive with --bucket) string
--configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
--full Fully restore and replace all data on server
-h --help Help for the restore command
--hide-headers Hide table headers (default false) INFLUX_HIDE_HEADERS
--host HTTP address of InfluxDB (default http://localhost:8086) string INFLUX_HOST
--json Output data as JSON (default false) INFLUX_OUTPUT_JSON
--new-bucket Name of the bucket to restore to string
--new-org Name of the organization to restore to string
-o --org Organization name (mutually exclusive with --org-id) string
--org-id Organization ID (mutually exclusive with --org) string
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
-t --token API token string INFLUX_TOKEN

Examples

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

Restore and replace all data
influx restore --full /path/to/backup/dir/
Restore backup data to an existing bucket
influx restore \
  --bucket example-bucket \
  /path/to/backup/dir/
Create a bucket and restore data to it
influx restore \
  --new-bucket new-example-bucket \
  /path/to/backup/dir/

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.