Authentication

Use the Authorization header with the Basic scheme to authenticate v1 API requests.

Works with v1 compatibility /write and /query endpoints in InfluxDB 3.

When authenticating requests, InfluxDB 3 checks that the password part of the decoded credential is an authorized token and ignores the username part of the decoded credential.

Syntax

Authorization: Basic <base64-encoded [USERNAME]:DATABASE_TOKEN>

Example

curl "http://cluster-host.com/write?db=DATABASE_NAME&precision=s" \
  --user "":"DATABASE_TOKEN" \
  --header "Content-type: text/plain; charset=utf-8" \
  --data-binary 'home,room=kitchen temp=72 1641024000'

Replace the following:

• DATABASE_NAME: your InfluxDB 3 Clustered database
• DATABASE_TOKEN: a database token with sufficient permissions to the database

For more information, see Authenticate v1 API requests and Manage tokens.

Use the OAuth Bearer authentication scheme to provide an authorization token to InfluxDB Clustered.

Bearer authentication works with all endpoints.

In your API requests, send an Authorization header. For the header value, provide the word Bearer followed by a space and a database token.

Syntax

Authorization: Bearer DATABASE_TOKEN

Example

curl http://cluster-host.com/api/v3/query_influxql \
  --header "Authorization: Bearer DATABASE_TOKEN"

Use InfluxDB 1.x API parameters to provide credentials through the query string for v1 API requests.

Querystring authentication works with v1-compatible /write and /query endpoints.

When authenticating requests, InfluxDB 3 checks that the p (password) query parameter is an authorized token and ignores the u (username) query parameter.

Syntax

https://cluster-host.com/query/?[u=any]&p=DATABASE_TOKEN
https://cluster-host.com/write/?[u=any]&p=DATABASE_TOKEN

Examples

curl "http://cluster-host.com/write?db=DATABASE_NAME&precision=s&p=DATABASE_TOKEN" \
  --header "Content-type: text/plain; charset=utf-8" \
  --data-binary 'home,room=kitchen temp=72 1641024000'

Replace the following:

• DATABASE_NAME: your InfluxDB 3 Clustered database
• DATABASE_TOKEN: a database token with sufficient permissions to the database

#######################################
# Use an InfluxDB 1.x compatible username and password
# to query the InfluxDB v1 HTTP API
#######################################
# Use authentication query parameters:
#   ?p=DATABASE_TOKEN
#######################################

curl --get "https://cluster-host.com/query" \
  --data-urlencode "p=DATABASE_TOKEN" \
  --data-urlencode "db=DATABASE_NAME" \
  --data-urlencode "q=SELECT * FROM MEASUREMENT"

Replace the following:

• DATABASE_NAME: the database to query
• DATABASE_TOKEN: a database token with sufficient permissions to the database

For more information, see Authenticate v1 API requests and Manage tokens.

Use InfluxDB v2 Token authentication to provide an authorization token to InfluxDB Clustered.

The v2 Token scheme works with v1 and v2 compatibility endpoints in InfluxDB Clustered.

In your API requests, send an Authorization header. For the header value, provide the word Token followed by a space and a database token. The word Token is case-sensitive.

Syntax

Authorization: Token DATABASE_TOKEN

Example

########################################################
# Use the Token authentication scheme with /api/v2/write
# to write data.
########################################################

curl --request post "https://cluster-host.com/api/v2/write?bucket=DATABASE_NAME&precision=s" \
  --header "Authorization: Token DATABASE_TOKEN" \
  --data-binary 'home,room=kitchen temp=72 1463683075'

For more information, see Manage tokens.