Documentation

influxdb3 create token admin

Create an operator token or named admin token.

Usage

influxdb3 create token --admin [OPTIONS]
  • Copy
  • Fill window

Options

OptionDescription
--regenerateRegenerates the operator token. Requires --token and the current operator token
--name <NAME>Name of the token
--expiry <EXPIRY>Expires in duration–for example, 10d for 10 days 1y for 1 year
--host <host>The host URL of the running InfluxDB 3 server [env: INFLUXDB3_HOST_URL=] [default: http://127.0.0.1:8181]
--token <token>An existing admin token for the InfluxDB 3 server
--tls-ca <tls-ca>An optional arg to use a custom ca for useful for testing with self signed certs
--format <FORMAT>Output format for token [possible values: json, text]
-h, --helpPrint help information
--help-allPrint more detailed help information

Examples

Create an operator token

The operator token is a special token that has full administrative privileges on the InfluxDB server and doesn’t expire. The first admin token you create becomes the operator token for the instance. You can create an operator token using the --admin flag without any additional options.

influxdb3 create token --admin
  • Copy
  • Fill window

The output is the raw token string you can use to authenticate future CLI commands and API requests. For CLI commands, use the --token option or the INFLUXDB3_AUTH_TOKEN environment variable to pass the token string.

Use the operator token to create a named admin token

influxdb3 create token \
  --admin \
  --token 
OPERATOR_TOKEN
\
--name
TOKEN_NAME
\
--expiry DURATION
  • Copy
  • Fill window

Replace the following:

  • OPERATOR_TOKEN: Your operator token for the server
  • TOKEN_NAME: Name for your new admin token
  • DURATION: Duration for the token to remain valid, in humantime format (for example, 10d for 10 days or 1y for 1 year).

Use the token to create a database

influxdb3 create database \
  --token ADMIN_TOKEN \
  
DATABASE_NAME
  • Copy
  • Fill window

Replace the following:

  • ADMIN_TOKEN: Your InfluxDB admin token
  • DATABASE_NAME: Name for your new database

Use CLI environment variables

Set the token as an environment variable to simplify repeated CLI commands:

export INFLUXDB3_AUTH_TOKEN=ADMIN_TOKEN
  • Copy
  • Fill window

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

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: