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

  1. influx auth active [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 active command
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
—http-debugInspect communication with InfluxDB servers.string
—hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
-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

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
  1. 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.