influxctl token create
The influxctl token create command creates a database token with specified
permissions to resources in an InfluxDB cluster and outputs
the token string.
The --read-database and --write-database flags support the * wildcard
which grants read or write permissions to all databases. Enclose wildcards in
single or double quotes–for example: '*' or "*".
The --format flag lets you print the output in other formats.
The json format is available for programmatic parsing by other tooling.
Default: table.
Notable behaviors
- InfluxDB might take some time–from a few seconds to a few minutes–to activate and synchronize new tokens.
If a new database token doesn’t immediately work (you receive a
401 Unauthorizederror) for querying or writing, wait and then try again. - Token strings are viewable only on token creation.
Store secure tokens in a secret store
Token strings are viewable only on token creation and aren’t stored by InfluxDB. We recommend storing database tokens in a secure secret store.
Usage
influxctl token create \
[--read-database=<DATABASE_NAME>] \
[--write-database=<DATABASE_NAME>] \
<TOKEN_DESCRIPTION>
Arguments
| Argument | Description |
|---|---|
| TOKEN_DESCRIPTION | Database token description |
Flags
| Flag | Description | |
|---|---|---|
--format | Output format (table (default) or json) | |
--read-database | Grant read permissions to a database (Repeatable) | |
--write-database | Grant write permissions to a database (Repeatable) | |
-h | --help | Output command help |
Also see influxctl global flags.
Examples
- Create a token with read and write access to a database
- Create a token with read and write access to all databases
- Create a token with read-only access to a database
- Create a token with read-only access to multiple databases
- Create a token with mixed permissions to multiple databases
In the examples below, replace the following:
DATABASE_NAME: your InfluxDB Clustered database nameDATABASE2_NAME: your second InfluxDB Clustered database nameTOKEN_ID: token ID to update
Create a token with read and write access to a database
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
"Read/write token for DATABASE_NAME"
Create a token with read and write access to all databases
influxctl token create \
--read-database "*" \
--write-database "*" \
"Read/write token for all databases"
Create a token with read-only access to a database
influxctl token create \
--read-database DATABASE_NAME \
"Read-only token for DATABASE_NAME"
Create a token with read-only access to multiple databases
influxctl token create \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
"Read-only token for DATABASE_NAME and DATABASE2_NAME"
Create a token with mixed permissions to multiple databases
influxctl token create \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
--write-database DATABASE2_NAME \
"Read-only on DATABASE_NAME, read/write on DATABASE2_NAME"
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB Clustered and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.