Documentation

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

Use the following endpoint to create an operator token:

curl -X POST "http://localhost:8181/api/v3/configure/token/admin" \
  • Copy
  • Fill window

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

Replace the following with your values:

  • ADMIN_TOKEN: your existing operator or named admin token
  • TOKEN_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"
          }'
  • Copy
  • Fill window

Replace the following with your values:

  • ADMIN_TOKEN: your existing operator or named admin token
  • TOKEN_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!


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

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: