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 Load Data > API Tokens.

  2. Find the token that you would like to enable or disable.

  3. Click the token description.

  4. 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
  • Copy
  • Fill window

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

influx auth find --json
  • Copy
  • Fill window

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
  • Copy
  • Fill window

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

influx auth find --json
  • Copy
  • Fill window

Update a token using the InfluxDB API

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

Include the following in your request:

RequirementInclude by
API token with the write: authorizations permissionUse the Authorization: Token YOUR_API_TOKEN header.
Authorization IDURL path parameter.
Description and/or StatusPass 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 .
  • Copy
  • Fill window

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.

Read more

InfluxDB 3 Core and Enterprise are now in Beta

InfluxDB 3 Core and Enterprise are now available for beta testing, available under MIT or Apache 2 license.

InfluxDB 3 Core is a high-speed, recent-data engine that collects and processes data in real-time, while persisting it to local disk or object storage. InfluxDB 3 Enterprise is a commercial product that builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries. A free tier of InfluxDB 3 Enterprise will also be available for at-home, non-commercial use for hobbyists to get the full historical time series database set of capabilities.

For more information, check out:

InfluxDB Cloud powered by TSM