influx restore

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+
  • Updated in CLI v2.0.7

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

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.

Cannot restore to existing buckets

The influx restore command cannot restore data to existing buckets. Use the --new-bucket flag to create a bucket with a new name and restore data into it. To restore data and retain bucket names, delete existing buckets and then begin the restore process.

Usage

  1. influx restore [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
-b—bucketName of the bucket to restore (mutually exclusive with —bucket-id)string
—bucket-idID of the bucket to restore (mutually exclusive with —bucket)string
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
—fullFully restore and replace all data on server
-h—helpHelp for the restore command
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
—hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
—http-debugInspect communication with InfluxDB servers.string
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
—new-bucketName of the bucket to restore tostring
—new-orgName of the organization to restore tostring
-o—orgOrganization name (mutually exclusive with —org-id)string
—org-idOrganization ID (mutually exclusive with —org)string
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t—tokenAPI tokenstringINFLUX_TOKEN

Examples

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:

Restore backup data
  1. influx restore /path/to/backup/dir/
Restore backup data for a specific bucket into a new bucket
  1. influx restore \
  2.   --bucket example-bucket \
  3.   --new-bucket new-example-bucket \
  4.   /path/to/backup/dir/
Restore and replace all data

influx restore --full restores all time series data and InfluxDB key-value data such as tokens, dashboards, users, etc.

  1. influx restore --full /path/to/backup/dir/

restore