influx restore
Works with InfluxDB OSS 2.x
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 durability.
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
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 | |
--http-debug | Inspect communication with InfluxDB servers. | string | ||
--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 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:
--host: InfluxDB host-o, --orgor--org-id: InfluxDB organization name or ID-t, --token: InfluxDB API token
- Restore backup data
- Restore backup data for a specific bucket into a new bucket
- Restore and replace all data
Restore backup data
influx restore /path/to/backup/dir/
Restore backup data for a specific bucket into a new bucket
influx restore \
--bucket example-bucket \
--new-bucket new-example-bucket \
/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.
influx restore --full /path/to/backup/dir/
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.