Create an admin token
Use the influxdb3 create token --admin subcommand
with the --name option or the HTTP API /api/v3/configure/token/admin endpoint
to create an admin token for your InfluxDB 3 Enterprise instance.
An admin token grants full access to all actions for your InfluxDB 3 instance and can be referenced by its name.
InfluxDB 3 Enterprise supports two types of admin tokens:
- Operator token: A system-generated administrative token with the name
_admin.- Cannot be edited or deleted
- Never expires
- Cannot be recreated if lost (future functionality)
- Can be regenerated using the CLI
- Named admin token: User-defined administrative tokens with full admin permissions.
- Can be created, edited, and deleted
- Support expiration dates
- Cannot modify or remove the operator token
An InfluxDB 3 Enterprise instance can have one operator token and unlimited named admin tokens.
Create an operator token Create a named admin token
Store secure tokens in a secret store
Token strings are returned only on token creation. We recommend storing database tokens in a secure secret store. Anyone with access to the named admin token has full control over your InfluxDB 3 Enterprise instance. If you lose the named admin token string, you must regenerate the token.
Create an operator token
The first admin token your create for your InfluxDB 3 Enterprise instance is the operator token.
Use the influxdb3 create token --admin command without a token name:
influxdb3 create token --adminUse the following endpoint to create an operator token:
curl -X POST "http://localhost:8181/api/v3/configure/token/admin" \The output contains the token string in plain text.
Create a named admin token
Use the influxdb3 create token --admin command with a token name:
influxdb3 create token --admin --token ADMIN_TOKEN --name "TOKEN_NAME"Replace the following with your values:
ADMIN_TOKEN: your existing operator or named admin tokenTOKEN_NAME: the name you want to assign to the new admin token
The output contains the token string in plain text.
Use the following endpoint to create a named admin token:
curl -X POST "http://localhost:8181/api/v3/configure/token/admin" \
--header 'Authorization Bearer ADMIN_TOKEN' \
--json '{
"name": "TOKEN_NAME"
}'Replace the following with your values:
ADMIN_TOKEN: your existing operator or named admin tokenTOKEN_NAME: the name you want to assign to the new admin token
The response body contains the token string in plain text.
To use the token as the default for later commands, and to persist the token
across sessions, assign the token string to the INFLUXDB3_AUTH_TOKEN environment variable.
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 3 Enterprise and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.