Documentation

Update a token

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

Update a token in the InfluxDB UI

  1. In the navigation menu on the left, select Data (Load Data) > API Tokens.
  1. Click the pencil icon next to the token’s name in the Description column.
  2. Update the token description, then click anywhere else to save.

Enable or disable a token in the InfluxDB UI

  1. In the navigation menu on the left, select Data (Load Data) > API Tokens.
  1. Click the Status toggle.

Enable a token using the influx CLI

Use the influx auth active command to activate a token.

This command requires an authorization ID, which is available in the output of influx auth find.

# Syntax
influx auth active -i <auth-id>

# Example
influx auth active -i 0804f74142bbf000

To get the current status of a token, use the JSON output of the influx auth list command.

influx auth find --json

Disable a token using the influx CLI

Use the influx auth inactive command to deactivate a token.

This command requires an authorization ID, which is available in the output of influx auth find.

# Syntax
influx auth inactive -i <auth-id>

# Example
influx auth inactive -i 0804f74142bbf000

To get the current status of a token, use the JSON output of the influx auth list command.

influx auth find --json

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 http://localhost:8086/api/v2/authorizations/AUTH_ID

Include the following in your request:

Requirement Include by
API token with the write: authorizations permission Use the Authorization: Token YOUR_API_TOKEN header.
Authorization ID URL path parameter.
Description and/or Status Pass as description, status in the request body.

Disable a token

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

curl --request GET \
  "http://localhost:8086/api/v2/authorizations?user=user2" \
  --header "Authorization: Token ${INFLUX_TOKEN}" \
  --header 'Content-type: application/json' \
| jq .authorizations[0].id \
| xargs -I authid curl --request PATCH \
  http://localhost:8086/api/v2/authorizations/authid \
  --header "Authorization: Token ${INFLUX_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: