Documentation

Update a database token

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.

Use the influxctl token update command to update a database token’s permissions in your InfluxDB cluster.

  1. If you haven’t already, download and install the influxctl CLI.

  2. Run the influxctl token create command and provide the following:

    • Token permissions (read and write)

      • --read-database: Grants read permissions to the specified database. Repeatable.
      • --write-database: Grants write permissions to the specified database. Repeatable.

      Both of these flags support the * wildcard which grants read or write permissions to all databases. Enclose wildcards in single or double quotes–for example: '*' or "*".

    • Token ID

influxctl token create \
  --read-database 
DATABASE_NAME
\
--write-database
DATABASE_NAME
\
TOKEN_ID

Replace the following:

  • DATABASE_NAME: your InfluxDB Clustered database
  • TOKEN ID: ID of the token to update

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.

Examples

In the examples below, Replace the following:

  • DATABASE_NAME: your InfluxDB Clustered database
  • DATABASE2_NAME: your InfluxDB Clustered database
  • TOKEN ID: ID of the token to update

Update a token with read and write access to a database

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 a database

influxctl token update \
  --read-database 
DATABASE_NAME
\
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!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: