Documentation

influx - InfluxDB command line interface

The influx command line interface (CLI) includes commands to manage many aspects of InfluxDB, including buckets, organizations, users, tasks, etc.

For information about setting up and configuring the influx CLI, see Download, install, and use the influx CLI.

Usage

influx [flags]
influx [command]

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.

Commands

Command Description
apply Apply an InfluxDB template
auth API token management commands
backup Back up data
bucket Bucket management commands
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
secret Manage secrets
setup Create default username, password, org, bucket, etc.
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

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

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).

cli

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.