Use a preconfigured admin token
Start InfluxDB 3 Enterprise with a preconfigured “offline” admin token file. If no admin tokens already exist, InfluxDB automatically creates an admin token using the provided admin token file. Offline tokens are designed to help with automated deployments.
Generate an offline admin token file
Use the influxdb3 create token --admin command to generate an offline admin
token file. Include the following options:
* Required
--name: The name of the admin token (default is_admin) (replaceTOKEN_NAME)--expiry: Duration for the token to remain valid, in humantime format (for example,10dfor 10 days or1yfor 1 year). (replaceDURATION)- *
--offline - *
--output-file: File path to use for the generated token file (replacepath/to/tokens.json)
influxdb3 create token --admin \
--name TOKEN_NAME \
--expiry DURATION \
--offline \
--output-file path/to/admin-token.jsonYou can write or generate your own admin token file
The influxdb3 create token --admin --offline command makes generating
offline admin token files easy, but it is not required.
You can also write or generate your own admin token files using the
required JSON schema.
Token string security standards
If writing or generating your own admin token file, ensure that the token string is sufficiently secure. We recommend the following:
- Use a cryptographically secure pseudorandom number generator.
- Ensure sufficient length and entropy. Generate and base64-encode a random string of at least 16 bytes (128 bits).
- Prepend the generated string with
apiv3_for InfluxDB compatibility.
Token file permissions
Token file permissions should be restricted 0600 to protect the token.
Offline admin token file schema
An offline admin token file is a JSON-formatted file that contains a single object with the following fields:
- token: The raw token string (must begin with
apiv3_) - name: The token name (default is
_admin) - expiry_millis: (Optional) Token expiration time as a millisecond Unix timestamp
{
"token": "apiv3_0XXXX-xxxXxXxxxXX_OxxxX...",
"name": "_admin",
"expiry_millis": 1756400061529
}Start InfluxDB with the preconfigured admin token
When starting InfluxDB 3 Enterprise, include the --admin-token-file option with the
influxdb3 serve command or set the INFLUXDB3_ADMIN_TOKEN_FILE environment
variable to provide the preconfigured offline admin token file:
influxdb3 serve \
# ... \
--admin-token-file path/to/admin-token.jsonINFLUXDB3_ADMIN_TOKEN_FILE=path/to/admin-token.json
influxdb3 serve \
# ... \When the server starts, you can use the preconfigured admin token to interact with your InfluxDB 3 Enterprise cluster or instance.
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.