influx backup

API token hashing is enabled by default in InfluxDB OSS 2.9.0

Stronger token security: tokens are stored as hashes on disk, so a copy of the database file doesn’t expose usable tokens. Existing tokens are hashed on first startup and the original strings can’t be recovered afterward — capture any plaintext tokens you still need before you upgrade.

For more information, see Token hashing.

The influx backup command backs up data stored in InfluxDB to a specified directory.

Usage

influx backup [flags] path

Flags

FlagDescriptionInput typeMaps to ?
-c--active-configCLI configuration to use for commandstring
--bucket-idID of the bucket to back up from (mutually exclusive with --bucket)string
-b--bucketName of the bucket to back up from (mutually exclusive with --bucket-id)string
--compressionCompression for local backup files. Defaults to gzip. Set to none to disable. If --gzip-compression-level=none and --compression is unset, defaults to none.string
--configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
--gzip-compression-levelServer-side gzip compression level for the backup download: default, full (best compression), speedy (fastest), or none. (2.8.0+)string
-h--helpHelp for the backup 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
-o--orgOrganization name (mutually exclusive with --org-id)stringINFLUX_ORG
--org-idOrganization ID (mutually exclusive with --org)stringINFLUX_ORG_ID
--skip-verifySkip TLS certificate verificationstringINFLUX_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
Back up all data to a directory
influx backup /path/to/backup/dir/
Back up all data to the current working directory
influx backup ./
Back up a specific bucket to a directory
influx backup --bucket example-bucket /path/to/backup/dir/
Back up using a faster server-side compression level

Requires InfluxDB 2.9.0+ and influx CLI 2.8.0+.

influx backup --gzip-compression-level speedy /path/to/backup/dir/

Was this page helpful?

Thank you for your feedback!