influxctl token update
Limited availability
InfluxDB Clustered is currently only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.
The influxctl token update command updates a database token with specified
permissions to resources in an InfluxDB cluster.
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 "*".
Usage
influxctl token update \
[--read-database=<DATABASE_NAME>] \
[--write-database=<DATABASE_NAME>] \
<TOKEN_ID>
Existing permissions are replaced on update
When updating token permissions, the existing permissions are replaced by the new permissions specified in the update command. To retain existing permissions, include them in the update command.
Arguments
| Argument | Description |
|---|---|
| TOKEN_ID | Database token ID to update |
Flags
| Flag | Description | |
|---|---|---|
--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
- Update a token’s permissions
- Update a token with read and write access to all databases
- Update a token with read-only access to multiple databases
- Update a token with mixed permissions to multiple databases
In the examples below, replace the following:
DATABASE_NAME: your InfluxDB Clustered databaseDATABASE2_NAME: your InfluxDB Clustered databaseTOKEN_ID: token ID to update
Update a token’s permissions
influxctl token update \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
TOKEN_ID
Update a token with read and write access to all databases
influxctl token update \
--read-database "*" \
--write-database "*" \
TOKEN_ID
Update a token with read-only access to multiple databases
influxctl token update \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
TOKEN_ID
Update a token with mixed permissions to multiple databases
influxctl token update \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
--write-database DATABASE2_NAME \
TOKEN_ID
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 and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.