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
influx backup [flags] path
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
-c | —active-config | CLI configuration to use for command | string | |
—bucket-id | ID of the bucket to back up from (mutually exclusive with —bucket ) | string | ||
-b | —bucket | Name of the bucket to back up from (mutually exclusive with —bucket-id ) | string | |
—compression | By default, gzip argument enables compression on downloaded files. Set to none to disable compression. | string | ||
—configs-path | Path to influx CLI configurations (default ~/.influxdbv2/configs ) | string | INFLUX_CONFIGS_PATH | |
-h | —help | Help for the backup 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 | ||
-o | —org | Organization name (mutually exclusive with —org-id ) | string | INFLUX_ORG |
—org-id | Organization ID (mutually exclusive with —org ) | string | INFLUX_ORG_ID | |
—skip-verify | Skip TLS certificate verification | string | 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, --org
or--org-id
: InfluxDB organization name or ID-t, --token
: InfluxDB API token- Back up all data to the current working directory
- Back up a specific bucket to a directory
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/
Related
- Back up data
- influx restore
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions