influx auth inactive

  • 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 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

  1. influx auth inactive [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-h—helpHelp for the inactive command
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
—hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
—http-debugInspect communication with InfluxDB servers.string
-i—id(Required) API token IDstring
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t—tokenAPI tokenstringINFLUX_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
  1. influx auth inactive --id 06c86c40a9f36000