Documentation

influx config create

This page documents an earlier version of InfluxDB. InfluxDB v2.6 is the latest stable version. View this page in the v2.6 documentation.

The influx config create command creates a InfluxDB connection configuration and stores it in a local file:

OS/PlatformCLI config file path
macOS~/.influxdbv2/configs
Linux (installed as binary)~/.influxdbv2/configs
Linux (installed as service)~/var/lib/influxdb/configs
Windows%USERPROFILE%\.influxdbv2\configs
Docker (DockerHub)/etc/influxdb2/configs
Docker (Quay.io)/root/.influxdbv2/configs
Kubernetes/etc/influxdb2/configs

To view CLI connection configurations after creating them, use influx config list.

Note: If you create multiple connection configurations (for example, separate admin and user configurations), use influx config <config-name> to switch to the configuration you want to use.

Usage

influx config create [flags]

Flags

FlagDescriptionInput typeMaps to ?
-a--activeSet the specified connection to be the active configuration.
-n--config-name(Required) Name of the new configuration.string
-h--helpHelp for the create command
--hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
-u--host-url(Required) Connection URL for the new configuration.string
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-o--orgOrganization namestring
-t--tokenAPI tokenstringINFLUX_TOKEN
-p--username-password(OSS only) Username (and optionally password) to use for authentication. Include username:password to ensure a session is automatically authenticated. Include username (without password) to prompt for a password before creating the session.string

Examples

Create a connection configuration and set it active

influx config create --active \
  -n config-name \
  -u http://localhost:8086 \
  -t mySuP3rS3cr3tT0keN \
  -o example-org

Create a connection configuration without setting it active

influx config create \
  -n config-name \
  -u http://localhost:8086 \
  -t mySuP3rS3cr3tT0keN \
  -o example-org

Create a connection configuration that uses a username and password

The influx CLI 2.4.0+ lets you create connection configurations that authenticate with InfluxDB OSS 2.4+ using the username and password combination that you would use to log into the InfluxDB user interface (UI). The CLI retrieves a session cookie and stores it, unencrypted, in your configs path.

Use the --username-password, -p option to provide your username and password using the <username>:<password> syntax. If no password is provided, the CLI will prompt for a password after each command that requires authentication.

influx config create \
  -n config-name \
  -u http://localhost:8086 \
  -p example-user:example-password \
  -o example-org

Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.