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
- Enable or disable a token in the InfluxDB UI
- Enable a token using the influx CLI
- Disable a token using the influx CLI
- Update a token using the 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
- On the token management page, click the pencil icon () next to the token’s description.
- Update the token description, and then click anywhere else to save.
Enable or disable a token in the InfluxDB UI
- On the token management page, find the token that you would like to enable or disable.
- Click the token description.
- 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 ofinflux 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 ofinflux 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 thewrite: authorizations
permission) - Content-type:
application/json
- Authorization:
- 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!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.