Documentation

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

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:

  • --host: InfluxDB host
  • -o, --org or --org-id: InfluxDB organization name or ID
  • -t, --token: InfluxDB API token
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!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

State of the InfluxDB Cloud Serverless documentation

InfluxDB Cloud Serverless documentation is a work in progress.

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.

InfluxDB Cloud Serverless