influx - InfluxDB command line interface
- InfluxDB OSS and influx CLI versions
Download and install the influx CLI
- Provide required authentication credentials
Usage
Commands
Flags
- Flag patterns and conventions

influx - InfluxDB command line interface

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 command line interface (CLI) includes commands to manage many aspects of InfluxDB, including buckets, organizations, users, tasks, etc.

InfluxDB OSS and influx CLI versions

Beginning with InfluxDB 2.1, the influx CLI is packaged and versioned separately from InfluxDB. InfluxDB and influx CLI versions may differ, but compatibility is noted for each command.

Download and install the influx CLI

Provide required authentication credentials

To avoid having to pass your InfluxDB host, API token, and organization with each command, store them in an influx CLI configuration (config). influx commands that require these credentials automatically retrieve these credentials from the active config.

Use the influx config create command to create an influx CLI config and set it as active:

influx config create --config-name <config-name> \
  --host-url http://localhost:8086 \
  --org <your-org> \
  --token <your-auth-token> \
  --active

For more information about managing CLI configurations, see the influx config documentation.

Usage

influx [flags]
influx [command]

Commands

Command	Description
apply	Apply an InfluxDB template
auth	API token management commands
backup	Back up data (InfluxDB OSS only)
bucket	Bucket management commands
bucket-schema	Manage InfluxDB bucket schemas (InfluxDB Cloud only)
completion	Generate completion scripts
config	Configuration management commands
dashboards	List dashboards
delete	Delete points from InfluxDB
export	Export resources as a template
help	Help about any command
org	Organization management commands
ping	Check the InfluxDB `/health` endpoint
query	Execute a Flux query
restore	Restore backup data (InfluxDB OSS only)
secret	Manage secrets
setup	Create default username, password, org, bucket, etc. (InfluxDB OSS only)
stacks	Manage InfluxDB stacks
task	Task management commands
telegrafs	Telegraf configuration management commands
template	Summarize and validate an InfluxDB template
user	User management commands
v1	Work with the v1 compatibility API
version	Print the influx CLI version
write	Write points to InfluxDB

Flags

Flag		Description
`-h`	`—help`	Help for the `influx` command

Flag patterns and conventions

The influx CLI uses the following patterns and conventions:

Mapped environment variables
Shorthand and longhand flags
Flag input types

Mapped environment variables

influx CLI flags mapped to environment variables are listed in the Mapped to column of the Flags table in each command documentation. Mapped flags inherit the value of the environment variable. To override environment variables, set the flag explicitly in your command.

View mapped environment variables

Some influx CLI commands may not support all mapped environment variables. For more information about what mapped environment variables each command supports, see the command documentation.

Environment variable	Description
`INFLUX_ACTIVE_CONFIG`	CLI configuration to use for commands
`INFLUX_BUCKET_ID`	Bucket ID
`INFLUX_BUCKET_NAME`	Bucket name
`INFLUX_CONFIGS_PATH`	Path to `influx` CLI configurations (default `~/.influxdbv2/configs`)
`INFLUX_HIDE_HEADERS`	Hide table headers in command output (default `false`)
`INFLUX_HOST`	HTTP address of InfluxDB (default `http://localhost:8086`)
`INFLUX_NAME`	InfluxDB Username
`INFLUX_ORG`	InfluxDB Organization name
`INFLUX_ORG_DESCRIPTION`	Organization description
`INFLUX_ORG_ID`	InfluxDB Organization ID
`INFLUX_OUTPUT_JSON`	Return command output JSON
`INFLUX_SKIP_VERIFY`	Skip TLS certificate verification
`INFLUX_TOKEN`	InfluxDB API token

Shorthand and longhand flags

Many influx CLI flags support both shorthand and longhand forms.

shorthand: a shorthand flag begins with a single hyphen followed by a single letter (for example: -c).
longhand: a longhand flag starts with two hyphens followed by a multi-letter, hyphen-spaced flag name (for example: --active-config).

Commands can use both shorthand and longhand flags in a single execution.

Flag input types

influx CLI flag input types are listed in each the table of flags for each command. Flags support the following input types:

string

Text string, but the flag can be used only once per command execution.

stringArray

Single text string, but the flag can be used multiple times per command execution.

integer

Sequence of digits representing an integer value.

duration

Length of time represented by an integer and a duration unit (1ns, 1us, 1µs, 1ms, 1s, 1m, 1h, 1d, 1w).

Install and use the influx CLI

cli

influx