influx backup

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

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 backup command backs up data stored in InfluxDB to a specified directory.

Usage

  1. 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
—compressionBy default, gzip argument enables compression on downloaded files. Set to none to disable compression.string
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-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:

Back up all data to a directory
  1. influx backup /path/to/backup/dir/
Back up all data to the current working directory
  1. influx backup ./
Back up a specific bucket to a directory
  1. influx backup --bucket example-bucket /path/to/backup/dir/

backup