Documentation

Update a token

Update an API token’s description and status using the InfluxDB user interface (UI), influx CLI, or InfluxDB API.

Update a token in the InfluxDB UI

To update tokens in the InfluxDB UI, navigate to the API Tokens management page. In the navigation menu on the left, select Load Data > API Tokens.

Update a token’s description

  1. On the token management page, click the pencil icon () next to the token’s description.
  2. Update the token description, and then click anywhere else to save.

Enable or disable a token in the InfluxDB UI

  1. On the token management page, find the token that you would like to enable or disable.
  2. Click the token description.
  3. Click the Active toggle.

Enable a token using the influx CLI

Use the influx auth active command to activate a token.

Provide the following flags:

  • --token: API token with permission to update authorizations
  • --id: Authorization ID to enable (available in the output of influx auth list)
influx auth active \
  --token 
API_TOKEN
\
--id
AUTHORIZATION_ID

Disable a token using the influx CLI

Use the influx auth inactive command to deactivate a token.

Provide the following flags:

  • --token: API token with permission to update authorizations
  • --id: Authorization ID to disable (available in the output of influx auth list)
influx auth inactive \
  --token 
API_TOKEN
\
--id
AUTHORIZATION_ID

Update a token using the InfluxDB API

Use the /api/v2/authorizations InfluxDB API endpoint to update the description and status of a token.

PATCH https://cloud2.influxdata.com/api/v2/authorizations/{AUTH_ID}

Include the following in your request:

  • Headers:
    • Authorization: Token API_TOKEN (API token with the write: authorizations permission)
    • Content-type: application/json
  • Path parameters:
    • authID: Authorization ID to update
  • Request body: JSON object with authorization properties to update

Disable a token

# Update the description and status of the first authorization listed for the user.

curl --request GET \
  https://cloud2.influxdata.com/api/v2/authorizations?user=user2 \
  --header "Authorization: Token 
API_TOKEN
"
\
--header 'Content-type: application/json' \ | jq .authorizations[0].id \ | xargs -I authid curl --request PATCH \ https://cloud2.influxdata.com/api/v2/authorizations/authid \ --header "Authorization: Token
API_TOKEN
"
\
--header 'Content-type: application/json' \ --data '{ "description": "deactivated_auth", "status": "inactive" }' | jq .

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is 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.

Learn more
Contact InfluxData Sales

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:

InfluxDB Cloud Serverless