influx auth active
- influx CLI 2.0.0+
- InfluxDB 2.0.0+
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 auth active
command activates an API token. Only active tokens authorize access to InfluxDB.
Usage
influx auth active [flags]
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
-c | —active-config | CLI configuration to use for command | string | |
—configs-path | Path to influx CLI configurations (default ~/.influxdbv2/configs ) | string | INFLUX_CONFIGS_PATH | |
-h | —help | Help for the active command | ||
—hide-headers | Hide table headers (default false ) | INFLUX_HIDE_HEADERS | ||
—http-debug | Inspect communication with InfluxDB servers. | string | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
-i | —id | (Required) API token ID | string | |
—json | Output data as JSON (default false ) | INFLUX_OUTPUT_JSON | ||
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | —token | API token | string | INFLUX_TOKEN |
Example
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
Activate an API token
influx auth active --id 06c86c40a9f36000
Note: For an overview of tokens and how they work, see Manage tokens. For more information on viewing tokens, see View tokens.