Update a database token

Use the influxctl token update command to update a database token's permissions in your {{< product-name omit=" Clustered" >}} 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

{{% code-placeholders "DATABASE_NAME|TOKEN_ID" %}}

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

{{% /code-placeholders %}}

Replace the following:

• {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: your {{< product-name >}} database
• {{% code-placeholder-key %}}TOKEN ID{{% /code-placeholder-key %}}: ID of the token to update

[!Note]

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

• Update a token with read and write access to a database
• Update a token with read and write access to all databases
• Update a token with read-only access to a database
• 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:

• {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: your {{< product-name >}} database
• {{% code-placeholder-key %}}DATABASE2_NAME{{% /code-placeholder-key %}}: your {{< product-name >}} database
• {{% code-placeholder-key %}}TOKEN ID{{% /code-placeholder-key %}}: ID of the token to update

Update a token with read and write access to a database

{{% code-placeholders "DATABASE_NAME|TOKEN_ID" %}}

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

{{% /code-placeholders %}}

Update a token with read and write access to all databases

{{% code-placeholders "TOKEN_ID" %}}

influxctl token update \
  --read-database "*" \
  --write-database "*" \
  TOKEN_ID

{{% /code-placeholders %}}

Update a token with read-only access to a database

{{% code-placeholders "DATABASE_NAME|TOKEN_ID" %}}

influxctl token update \
  --read-database DATABASE_NAME \
  TOKEN_ID

{{% /code-placeholders %}}

Update a token with read-only access to multiple databases

{{% code-placeholders "DATABASE_NAME|DATABASE2_NAME|TOKEN_ID" %}}

influxctl token update \
  --read-database DATABASE_NAME \
  --read-database DATABASE2_NAME \
  TOKEN_ID

{{% /code-placeholders %}}

Update a token with mixed permissions to multiple databases

{{% code-placeholders "DATABASE_NAME|DATABASE2_NAME|TOKEN_ID" %}}

influxctl token update \
  --read-database DATABASE_NAME \
  --read-database DATABASE2_NAME \
  --write-database DATABASE2_NAME \
  TOKEN_ID

{{% /code-placeholders %}}