Auth token

Download InfluxDB 3 Enterprise API Spec
Create and manage tokens used for authenticating and authorizing access to InfluxDB 3 Enterprise resources.
DELETE /api/v3/configure/token

Delete token

Deletes a token.

Parameters

Query parameters
token_name required string
The name of the token to delete.
Example request Ask AI about this
curl --request DELETE \
  "https://localhost:8181/api/v3/configure/token?token_name=TOKEN_NAME" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. The token has been deleted.
401 Unauthorized access.
data object
error string
404 Token not found.
POST /api/v3/configure/token/admin

Create admin token

Creates an admin token. An admin token is a special type of token that has full access to all resources in the system.
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/api/v3/configure/token/admin" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

201 Success. The admin token has been created. The response body contains the token string and metadata.
created_at string <date-time>
expiry string <date-time>
hash string
id integer
name string
token string
Example request body
{
  "created_at": "2025-04-18T14:02:45.331Z",
  "expiry": null,
  "hash": "00xx0Xx0xx00XX0x0",
  "id": 0,
  "name": "_admin",
  "token": "apiv3_00xx0Xx0xx00XX0x0"
}
401 Unauthorized access.
data object
error string
POST /api/v3/configure/token/admin/regenerate

Regenerate admin token

Regenerates an admin token and revokes the previous token with the same name.
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/api/v3/configure/token/admin/regenerate" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

201 Success. The admin token has been regenerated.
created_at string <date-time>
expiry string <date-time>
hash string
id integer
name string
token string
Example request body
{
  "created_at": "2025-04-18T14:02:45.331Z",
  "expiry": null,
  "hash": "00xx0Xx0xx00XX0x0",
  "id": 0,
  "name": "_admin",
  "token": "apiv3_00xx0Xx0xx00XX0x0"
}
401 Unauthorized access.
data object
error string
POST /api/v3/configure/token/named_admin

Create named admin token

Creates a named admin token. A named admin token is a special type of admin token with a custom name for identification and management.

Request body required

Content-Type: application/json
expiry_secs integer
Optional expiration time in seconds. If not provided, the token does not expire.
token_name required string
The name for the admin token.
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/api/v3/configure/token/named_admin" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "expiry_secs": 0,
  "token_name": "TOKEN_NAME"
}'

Responses

201 Success. The named admin token has been created. The response body contains the token string and metadata.
created_at string <date-time>
expiry string <date-time>
hash string
id integer
name string
token string
Example request body
{
  "created_at": "2025-04-18T14:02:45.331Z",
  "expiry": null,
  "hash": "00xx0Xx0xx00XX0x0",
  "id": 0,
  "name": "_admin",
  "token": "apiv3_00xx0Xx0xx00XX0x0"
}
401 Unauthorized access.
data object
error string
409 A token with this name already exists.
POST /api/v3/enterprise/configure/token

Create a resource token

Creates a resource (fine-grained permissions) token. A resource token is a token that has access to specific resources in the system.

This endpoint is only available in InfluxDB 3 Enterprise.

Request body required

Content-Type: application/json
expiry_secs integer
Optional expiration time in seconds.
permissions required object[]
List of permissions to grant to the token.
token_name required string
The name for the resource token.
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/api/v3/enterprise/configure/token" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "expiry_secs": 0,
  "permissions": [],
  "token_name": "TOKEN_NAME"
}'

Responses

201 Success. The resource token has been created. The response body contains the token string and metadata.
expiry_secs integer
The expiration time in seconds.
permissions object[]
actions string[]
resource_names string[]
List of resource names. Use “*” for all resources.
resource_type string
Allowed: system , db
token_name string
Example request body
{
  "expiry_secs": 300000,
  "permissions": [
    {
      "actions": [
        "read"
      ],
      "resource_names": [
        "*"
      ],
      "resource_type": "system"
    }
  ],
  "token_name": "All system information"
}
401 Unauthorized access.
data object
error string

Was this page helpful?

Thank you for your feedback!