influx auth inactive
- influx CLI 2.0.0+
- InfluxDB 2.0.0+
The influx auth inactive
command inactivates an API token in InfluxDB. Inactive tokens do not authorize access to InfluxDB.
To temporarily disable client access to InfluxDB, inactivate the authentication token the client is using rather than delete the token. If you delete the token, you have to generate a new token and update the client with the new token. By setting a token to inactive, you can activate the token to grant the client access without having to modify the client.
Usage
influx auth inactive [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 inactive command | ||
—hide-headers | Hide table headers (default false ) | INFLUX_HIDE_HEADERS | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
—http-debug | Inspect communication with InfluxDB servers. | string | ||
-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 |
Examples
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
Inactivate an API token
influx auth inactive --id 06c86c40a9f36000