influxctl
The influxctl command line interface (CLI) performs administrative tasks in
an InfluxDB Cloud Dedicated cluster.
Usage
influxctl [flags] [command]
Commands
| Command | Description |
|---|---|
| database | Manage InfluxDB databases |
| token | Manage InfluxDB database tokens |
| version | Output the current influxctl version |
| help | Output influxctl help information |
Global flags
| Flag | Description |
|---|---|
--debug | Enable debug logging |
--profile | Specify a connection profile to use (default is default) |
Download and install influxctl
Contact InfluxData Support for
information about downloading and installing the influxctl CLI.
Configure connection profiles
To connect with your InfluxDB Cloud Dedicated cluster, influxctl needs the
following credentials:
- InfluxDB Cloud Dedicated account ID
- InfluxDB Cloud Dedicated cluster ID
Use the influxctl init command
to start an interactive prompt that creates and stores the required credentials
as a connection profile.
influxctl init
Connection profile store location
The influxctl CLI stores connection profiles in a config.toml file at a specific
location based on your operating system:
Profile configuration file locations
| Operating system | Profile configuration filepath |
|---|---|
| Linux | ~/.config/influxctl/config.toml |
| macOS | ~/Library/Application Support/influxctl/config.toml |
| Windows | %APPDATA%\influxctl\config.toml |
Authentication
The influxctl CLI uses Auth0 to authenticate access to
your InfluxDB Cloud Dedicated cluster.
When you issue an influxctl command, the CLI checks for an active Auth0 token.
If none exists, you are directed to login to Auth0 via a browser using
credentials you should have created when setting up your InfluxDB Cloud
Dedicated cluster.
Auth0 issues a short-lived (1 hour) token that authenticates access to your
InfluxDB Cloud Dedicated cluster.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.