Create a token
Create API tokens using the InfluxDB user interface (UI), the influx
command line interface (CLI), or the InfluxDB API.
Tokens are visible only to the user who created them and stop working when the user is deactivated. We recommend creating a generic IT user to create and manage tokens for writing data.
Create a token in the InfluxDB UI
In the navigation menu on the left, select Data (Load Data) > Tokens.
Click Generate and select a token type (Read/Write Token or All-Access Token).
In the window that appears, enter a description for your token in the Description field.
If generating a read/write token:
- Search for and select buckets to read from in the Read pane.
- Search for and select buckets to write to in the Write pane.
Click Save.
Create a token using the influx CLI
Use the influx auth create command to create a token.
Include flags with the command to grant specific permissions to the token.
See the available flags.
Only tokens with the write: authorizations permission can create tokens.
# Syntax
influx auth create -o <org-name> [permission-flags]
# Example
influx auth create -o my-org \
--read-bucket 03a2bbf46309a000 \
--read-bucket 3a87c03ace269000 \
--read-dashboards \
--read-tasks \
--read-telegrafs \
--read-user
See the influx auth create documentation for information about other available flags.
Create a token using the InfluxDB API
Use the /authorizations endpoint of the InfluxDB API to create a token.
POST /api/v2/authorizations
Include the following in your request:
| Requirement | Include by |
|---|---|
API token with the write: authorizations permission | Use the Authorization: Token YOUR_API_TOKEN header. |
| Organization | Pass as orgID in the request body. |
| Permissions list | Pass as a permissions array in the request body. |
INFLUX_ORG_ID=YOUR_ORG_ID
INFLUX_API_TOKEN=YOUR_API_TOKEN
curl -v --request POST \
http://localhost:8086/api/v2/authorizations \
--header "Authorization: Token ${INFLUX_API_TOKEN}" \
--header 'Content-type: application/json' \
--data '{
"status": "active",
"description": "iot-center-device",
"orgID": "'"${INFLUX_ORG_ID}"'",
"permissions": [
{
"action": "read",
"resource": {
"type": "authorizations"
}
},
{
"action": "read",
"resource": {
"type": "buckets"
}
},
{
"action": "write",
"resource": {
"type": "buckets",
"name": "iot-center"
}
}
]
}'
Create a token scoped to a user
To scope a token to a user other than the token creator, pass userID in the request
body.
######################################################
# The example below uses common command-line tools
# `curl`, `jq` with the InfluxDB API to do the following:
# 1. Create a user.
# 2. Find the new or existing user by name.
# 3. If the user exists:
# a. Build an authorization object with the user ID.
# b. Create the new authorization.
# c. Return the new token.
######################################################
INFLUX_TOKEN=YOUR_API_TOKEN
function create_token_with_user() {
curl --request POST \
"http://localhost:8086/api/v2/users/" \
--header "Authorization: Token ${INFLUX_TOKEN}" \
--header 'Content-type: application/json' \
--data "{\"name\": \"$1\"}"
curl --request GET \
"http://localhost:8086/api/v2/users?name=$1" \
--header "Authorization: Token ${INFLUX_TOKEN}" \
--header 'Content-type: application/json' | \
jq --arg USER $1 '.users[0] // error("User missing")
| {
"orgID": "YOUR_ORG_ID",
"userID": .id,
"description": $USER,
"permissions": [
{"action": "read", "resource": {"type": "buckets"}}
]
}' | \
curl --request POST \
"http://localhost:8086/api/v2/authorizations" \
--header "Authorization: Token ${INFLUX_TOKEN}" \
--header 'Content-type: application/json' \
--data @- | \
jq '.token'
}
create_token_with_user 'iot_user_1'
See the
POST /api/v2/authorizations documentation
for more information about options.
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, the following resources are available:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.