influxdb3 create token --admin
Create an operator token or named admin token.
Usage
influxdb3 create token --admin [OPTIONS]Options
| Option | Description |
|---|---|
--regenerate | Regenerates the operator token. Requires --token and the current operator token |
--name | Name of the token |
--expiry | Expires in duration–for example, 10d for 10 days 1y for 1 year |
--host | The host URL of the running InfluxDB 3 server [env: INFLUXDB3_HOST_URL=] [default: http://127.0.0.1:8181] |
--token | An existing admin token for the InfluxDB 3 server |
--tls-ca | An optional arg to use a custom ca for useful for testing with self signed certs |
--format | Output format for token [possible values: json, text] |
--offline | Generate token without connecting to server (for automation) |
--output-file | File path to save the token (required with --offline) |
-h, --help | Print help information |
--help-all | Print more detailed help information |
Examples
- Create an operator token
- Use the operator token to create a named admin token
- Use the token to create a database
- Generate an offline admin token
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 --adminThe 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 Replace the following:
OPERATOR_TOKEN: Your operator token for the serverTOKEN_NAME: Name for your new admin tokenDURATION: Duration for the token to remain valid, in humantime format (for example,10dfor 10 days or1yfor 1 year).
Use the token to create a database
influxdb3 create database \
--token ADMIN_TOKEN \
DATABASE_NAMEReplace the following:
ADMIN_TOKEN: Your InfluxDB admin tokenDATABASE_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_TOKENGenerate an offline admin token
Generate an offline admin token file to use if no tokens exist when the server starts. Once started, you can interact with the server using the provided token. Offline admin tokens are designed to help with automated deployments.
Include the following options:
--offline(Required)--output-file(Required)--name(default is_admin)--expiry(Optional)
influxdb3 create token --admin \
--name TOKEN_NAME \
--expiry DURATION \
--offline \
--output-file path/to/admin-token.jsonReplace the following:
TOKEN_NAME: Name for your offline admin tokenDURATION: Duration for the token to remain valid, in humantime format (for example,10dfor 10 days or1yfor 1 year).path/to/admin-token.json: File path to use for the generated token file
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.