Manage API tokens
This page documents an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.
InfluxDB API tokens ensure secure interaction between InfluxDB and external tools such as clients or applications. An API token belongs to a specific user and identifies InfluxDB permissions within the user’s organization.
Learn how to create, view, update, or delete an API token.
API token types
Operator token
Grants full read and write access to all organizations and all organization resources in InfluxDB OSS 2.x. Some operations–for example, retrieving the server configuration–require operator permissions.
Initial operator token
When you first initialize InfluxDB, the setup process creates an initial user, org, bucket, and an Operator token with full read/write access to all organizations. When running setup, you can either:
- Supply the token value yourself (
influx setup --tokenflag or the setup APItokenfield), or - Let InfluxDB auto-generate it. InfluxDB stores the generated token in the active influx CLI config so the CLI can use it later.
Creating operator tokens after setup
To create an operator token manually with the InfluxDB UI, api/v2 API, or influx CLI after the setup process is completed, you must use an existing Operator token.
To create a new Operator token without using an existing one, see how to use the influxd recovery auth CLI.
Because Operator tokens have full read and write access to all organizations in the database, we recommend creating an All Access token for each organization and using those to manage InfluxDB. This helps to prevent accidental interactions across organizations.
All Access token
Grants full read and write access to all resources in an organization.
Read/Write token
Grants read access, write access, or both to specific buckets in an organization.
Create a token
Create an API token in InfluxDB using the InfluxDB UI, the influx CLI, or the InfluxDB API.
View tokens
View API tokens in InfluxDB using the InfluxDB UI, the influx CLI, or the InfluxDB API.
Update a token
Update API tokens’ descriptions in InfluxDB using the InfluxDB UI.
Delete a token
Delete an API token from InfluxDB using the InfluxDB UI or the influx CLI.
Use tokens
Use an API token in the InfluxDB UI, the influx CLI, or the InfluxDB API.
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 and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.