docs-v2/content/influxdb/v2.1/reference/cli/influx/auth/inactive.md

2.5 KiB

title description menu weight
influx auth inactive The `influx auth inactive` command inactivates an API token in InfluxDB.
influxdb_2_1_ref
name parent
influx auth inactive influx auth
201

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 {{< cli/mapped >}}
-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 ({{< req >}}) 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

{{< cli/influx-creds-note >}}

Inactivate an API token
influx auth inactive --id 06c86c40a9f36000