Documentation

InfluxDB Cloud Dedicated

Create a database token

Use the influxctl CLI or the Management HTTP API to create a database token with permissions for reading and writing data in your InfluxDB Cloud Dedicated cluster.

influxctl Management API

Use the influxctl token create command to create a token that grants access to databases in your InfluxDB Cloud Dedicated cluster.

  1. If you haven’t already, download and install the influxctl CLI, and then configure an influxctl connection profile for your cluster.

  2. In your terminal, run the influxctl token create command and provide the following:

    • Token permissions (read and write)

      • --read-database: Grants read permissions to the specified database. Repeatable.
      • --write-database: Grants write permissions to the specified database. Repeatable.

      Both of these flags support the * wildcard which grants read or write permissions to all databases. Enclose wildcards in single or double quotes–for example: '*' or "*".

    • Token description

influxctl token create \
  --read-database 
DATABASE_NAME
 \
  --write-database 
DATABASE_NAME
 \
    "Read/write token for 
DATABASE_NAME
"

Replace the following:

  • DATABASE_NAME: your InfluxDB Cloud Dedicated database

The output is the token ID and the token string. This is the only time the token string is available in plain text.

This example uses cURL to send a Management HTTP API request, but you can use any HTTP client.

  1. If you haven’t already, follow the instructions to install cURL for your system.

  2. In your terminal, use cURL to send a request to the following InfluxDB Cloud Dedicated endpoint:

    POST https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens

    In the URL, provide the following credentials:

    Provide the following request headers:

    • Accept: application/json to ensure the response body is JSON content
    • Content-Type: application/json to indicate the request body is JSON content
    • Authorization: Bearer and a Management API token for your cluster (see how to create a management token for Management API requests).

    In the request body, provide the following parameters:

    • permissions: an array of token permissions (read or write) objects:
      • "action": Specify read or write permission to the database.
      • "resource": Specify the database name.
    • description: Provide a description of the token.

The following example shows how to use the Management API to create a database token:

curl \
   --location "https://console.influxdata.com/api/v0/accounts/
ACCOUNT_ID
/clusters/
CLUSTER_ID
/tokens" \
   --header "Accept: application/json" \
   --header 'Content-Type: application/json' \
   --header "Authorization: Bearer 
MANAGEMENT_TOKEN
" \
   --data '{
     "description": "Read/write token for 
DATABASE_NAME
",
     "permissions": [
       {
         "action": "write",
         "resource": "
DATABASE_NAME
"
       },
       {
         "action": "read",
         "resource": "
DATABASE_NAME
"
       }
     ]
   }'

Replace the following in your request:

  • ACCOUNT_ID: the ID of the InfluxDB Cloud Dedicated account to create the database token for
  • CLUSTER_ID: the ID of the InfluxDB Cloud Dedicated cluster to create the database token for
  • MANAGEMENT TOKEN: a management token for your InfluxDB Cloud Dedicated cluster
  • DATABASE_NAME: a InfluxDB Cloud Dedicated database that the token will have read or write permission to

The response body contains the token ID and the token string. This is the only time the token string is available in plain text.

Notable behaviors

  • InfluxDB might take some time–from a few seconds to a few minutes–to activate and synchronize new tokens. If a new database token doesn’t immediately work (you receive a 401 Unauthorized error) for querying or writing, wait and then try again.
  • Token strings are viewable only on token creation.

Store secure tokens in a secret store

Token strings are viewable only on token creation and aren’t stored by InfluxDB. We recommend storing database tokens in a secure secret store. For example, see how to authenticate Telegraf using tokens in your OS secret store.

If you lose a token, delete the token from InfluxDB and create a new one.

Output format

The influxctl token create command supports the --format json option. By default, the command outputs the token string. For token details and easier programmatic access to the command output, include --format json with your command to format the output as JSON.

The Management API outputs JSON format in the response body.

Examples

In the examples below, replace the following:

  • DATABASE_NAME: your InfluxDB Cloud Dedicated database
  • DATABASE2_NAME: your InfluxDB Cloud Dedicated database
  • ACCOUNT_ID: the ID of the InfluxDB Cloud Dedicated account to create the database token for
  • CLUSTER_ID: the ID of the InfluxDB Cloud Dedicated cluster to create the database token for
  • MANAGEMENT TOKEN: a management token for your InfluxDB Cloud Dedicated cluster

Create a token with read and write access to a database

influxctl Management API

influxctl token create \
  --read-database 
DATABASE_NAME
 \
  --write-database 
DATABASE_NAME
 \
  "Read/write token for 
DATABASE_NAME
"

curl \
   --location "https://console.influxdata.com/api/v0/accounts/
ACCOUNT_ID
/clusters/
CLUSTER_ID
/tokens" \
   --header "Accept: application/json" \
   --header 'Content-Type: application/json' \
   --header "Authorization: Bearer 
MANAGEMENT_TOKEN
" \
   --data '{
     "description": "Read/write token for 
DATABASE_NAME
",
     "permissions": [
       {
         "action": "write",
         "resource": "
DATABASE_NAME
"
       },
       {
         "action": "read",
         "resource": "
DATABASE_NAME
"
       }
     ]
   }'

Create a token with read and write access to all databases

influxctl Management API

influxctl token create \
  --read-database "*" \
  --write-database "*" \
  "Read/write token for all databases"

curl \
   --location "https://console.influxdata.com/api/v0/accounts/
ACCOUNT_ID
/clusters/
CLUSTER_ID
/tokens" \
   --header "Accept: application/json" \
   --header 'Content-Type: application/json' \
   --header "Authorization: Bearer 
MANAGEMENT_TOKEN
" \
   --data '{
     "description": "Read/write token for all databases",
     "permissions": [
       {
         "action": "write",
         "resource": "*"
       },
       {
         "action": "read",
         "resource": "*"
       }
     ]
   }'

Create a token with read-only access to a database

influxctl Management API

influxctl token create \
  --read-database 
DATABASE_NAME
 \
  "Read-only token for 
DATABASE_NAME
"

curl \
   --location "https://console.influxdata.com/api/v0/accounts/
ACCOUNT_ID
/clusters/
CLUSTER_ID
/tokens" \
   --header "Accept: application/json" \
   --header 'Content-Type: application/json' \
   --header "Authorization: Bearer 
MANAGEMENT_TOKEN
" \
   --data '{
     "description": "Read-only token for 
DATABASE_NAME
",
     "permissions": [
       {
         "action": "read",
         "resource": "
DATABASE_NAME
"
       }
     ]
   }'

Create a token with read-only access to multiple databases

influxctl Management API

influxctl token create \
  --read-database 
DATABASE_NAME
 \
  --read-database 
DATABASE2_NAME
 \
  "Read-only token for 
DATABASE_NAME
 and 
DATABASE2_NAME
"

curl \
   --location "https://console.influxdata.com/api/v0/accounts/
ACCOUNT_ID
/clusters/
CLUSTER_ID
/tokens" \
   --header "Accept: application/json" \
   --header 'Content-Type: application/json' \
   --header "Authorization: Bearer 
MANAGEMENT_TOKEN
" \
   --data '{
     "description": "Read-only token for 
DATABASE_NAME
 and 
DATABASE2_NAME
",
     "permissions": [
       {
         "action": "read",
         "resource": "
DATABASE_NAME
"
       },
       {
         "action": "read",
         "resource": "
DATABASE2_NAME
"
       }
     ]
   }'

Create a token with mixed permissions to multiple databases

influxctl Management API

influxctl token create \
  --read-database 
DATABASE_NAME
 \
  --read-database 
DATABASE2_NAME
 \
  --write-database 
DATABASE2_NAME
 \
  "Read-only on 
DATABASE_NAME
, read/write on 
DATABASE2_NAME
"

curl \
   --location "https://console.influxdata.com/api/v0/accounts/
ACCOUNT_ID
/clusters/
CLUSTER_ID
/tokens" \
   --header "Accept: application/json" \
   --header 'Content-Type: application/json' \
   --header "Authorization: Bearer 
MANAGEMENT_TOKEN
" \
   --data '{
     "description": "Read-only on 
DATABASE_NAME
, read/write on 
DATABASE2_NAME
",
     "permissions": [
       {
         "action": "read",
         "resource": "
DATABASE_NAME
"
       },
       {
         "action": "read",
         "resource": "
DATABASE2_NAME
"
       },
       {
         "action": "write",
         "resource": "
DATABASE2_NAME
"
       },
     ]
   }'

Was this page helpful?

Thank you for your feedback!

© 2024 InfluxData, Inc.

What is your InfluxDB Cloud Dedicated cluster URL?

Enter your InfluxDB Cloud Dedicated cluster URL and we’ll update code examples for you.

Enter cluster URL

Thank you for your feedback!

Let us know what we can do better:

Thank you!

No thanks

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

InfluxDB v3 enhancements and InfluxDB Clustered is now generally available

New capabilities, including faster query performance and management tooling advance the InfluxDB v3 product line. InfluxDB Clustered is now generally available.

InfluxDB v3 performance and features

The InfluxDB v3 product line has seen significant enhancements in query performance and has made new management tooling available. These enhancements include an operational dashboard to monitor the health of your InfluxDB cluster, single sign-on (SSO) support in InfluxDB Cloud Dedicated, and new management APIs for tokens and databases.

Learn about the new v3 enhancements

InfluxDB Clustered general availability

InfluxDB Clustered is now generally available and gives you the power of InfluxDB v3 in your self-managed stack.

Talk to us about InfluxDB Clustered