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) > 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.

     <div class="nav-items-v3">
       <div class="nav-item-v3">
         <div class="nav-icon-v3">
           <span class="cf-icon ingest-new"></span>
         </div>
       </div>
       <div class="nav-item-v3">
         <div class="nav-icon-v3">
           <span class="cf-icon ingest-new"></span>
         </div>
         <p class="nav-label-v3">Load Data</p>
       </div>
     </div>
    
  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

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:

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 .

Was this page helpful?

Thank you for your feedback!


Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.