influx auth create

influx auth create

influx CLI 2.0.0+
InfluxDB 2.0.0+
Updated in CLI v2.3.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 create command creates an API token in InfluxDB.

Usage

influx auth create [flags]

Flags

Flag		Description	Input type	Maps to ?
`-c`	`—active-config`	CLI configuration to use for command	string
	`—all-access`	Grants all permissions in a single organization
	`—configs-path`	Path to `influx` CLI configurations (default `~/.influxdbv2/configs`)	string	`INFLUX_CONFIGS_PATH`
`-d`	`—description`	API token description	string
`-h`	`—help`	Help for the `create` 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
	`—json`	Output data as JSON (default `false`)		`INFLUX_OUTPUT_JSON`
	`—operator`	(InfluxDB OSS only) Grants all permissions in all organizations	string
`-o`	`—org`	Organization name (mutually exclusive with `—org-id`)	string	`INFLUX_ORG`
	`—org-id`	Organization ID (mutually exclusive with `—org`)	string	`INFLUX_ORG_ID`
	`—read-bucket`	Grant permission to read a specified bucket ID	stringArray
	`—read-buckets`	Grant permission to read all organization buckets
	`—read-checks`	Grant permission to read checks
	`—read-dashboards`	Grant permission to read dashboards
	`—read-dbrps`	Grant permission to read database retention policy mappings
	`—read-notificationEndpoints`	Grant permission to read notificationEndpoints
	`—read-notificationRules`	Grant permission to read notificationRules
	`—read-orgs`	Grant permission to read organizations
	`—read-remotes`	Grant permission to read remote configurations
	`—read-replications`	Grant permission to read replication configurations
	`—read-tasks`	Grant permission to read tasks
	`—read-telegrafs`	Grant permission to read Telegraf configurations
	`—read-users`	Grant permission to read organization users
	`—skip-verify`	Skip TLS certificate verification		`INFLUX_SKIP_VERIFY`
`-t`	`—token`	API token	string	`INFLUX_TOKEN`
`-u`	`—user`	Username	string
	`—write-annotations`	Grant permission to create annotations
	`—write-bucket`	Grant permission to write to specified a bucket ID	stringArray
	`—write-buckets`	Grant permission to create and update all organization buckets
	`—write-checks`	Grant permission to create checks
	`—write-dashboards`	Grant permission to create and update dashboards
	`—write-dbrps`	Grant permission to create database retention policy mappings
	`—write-notificationEndpoints`	Grant permission to create notificationEndpoints
	`—write-notificationRules`	Grant permission to create notificationRules
	`—write-orgs`	Grant permission to create and update organizations
	`—write-remotes`	Grant permission to create and update remote configurations
	`—write-replications`	Grant permission to create and update replication configurations
	`—write-tasks`	Grant permission to create and update tasks
	`—write-telegrafs`	Grant permission to create and update Telegraf configurations
	`—write-users`	Grant permission to create and update organization users
	`—write-variables`	Grant permission to create and update variables

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
Create an All-Access API token or Create an Operator API token
Create an API token with specified read and write permissions
Create a token with read and write access to specific buckets
Create a read-only API token

Create an All-Access API token

Create an All-Access token to grant permissions to all resources in an organization.

influx auth create \
  --all-access

Create an Operator API token

Create an Operator token to grant permissions to all resources in all organizations.

influx auth create \
  --operator

Create an API token with specified read and write permissions

influx auth create \
  --read-buckets \
  --read-checks \
  --read-dashboards \
  --read-dbrps \
  --read-notificationEndpoints \
  --read-notificationRules \
  --read-orgs \
  --read-remotes \
  --read-replications \
  --read-tasks \
  --read-telegrafs \
  --read-users \
  --write-annotations \
  --write-buckets \
  --write-checks \
  --write-dashboards \
  --write-dbrps \
  --write-notificationEndpoints \
  --write-notificationRules \
  --write-orgs \
  --write-remotes \
  --write-replications \
  --write-tasks \
  --write-telegrafs \
  --write-users \
  --write-variables

Create an API token with read and write access to specific buckets

influx auth create \
  --read-bucket 0000000000000001 \
  --read-bucket 0000000000000002 \
  --write-bucket 0000000000000001 \
  --write-bucket 0000000000000002

Create a read-only API token

influx auth create \
  --read-buckets \
  --read-checks \
  --read-dashboards \
  --read-dbrps \
  --read-notificationEndpoints \
  --read-notificationRules \
  --read-orgs \
  --read-remotes \
  --read-replications \
  --read-tasks \
  --read-telegrafs \
  --read-users