Use the InfluxDB v1 HTTP query API and InfluxQL to query data

Use the InfluxDB v1 HTTP query API to query data in InfluxDB 3 Enterprise with InfluxQL.

The examples below use cURL to send HTTP requests to the InfluxDB v1 HTTP API, but you can use any HTTP client.

Use the v1 /query endpoint and the GET request method to query data with InfluxQL:

GET http://localhost:8181/query

Authenticate API requests

InfluxDB 3 Enterprise requires each API request to be authenticated with a token. With InfluxDB v1-compatible endpoints in InfluxDB 3, you can use database tokens in InfluxDB 1.x username and password schemes, in the InfluxDB v2 Authorization: Token scheme, or in the OAuth Authorization: Bearer scheme.

• Authenticate with a username and password scheme
• Authenticate with a token scheme

Authenticate with a username and password scheme

With InfluxDB v1-compatible endpoints in InfluxDB 3, you can use the InfluxDB 1.x convention of username and password to authenticate database reads by passing a token with read access to the database as the password credential. When authenticating requests to the v1 API /query endpoint, InfluxDB 3 Enterprise checks that the password (p) value is an authorized token with read access to the database. InfluxDB 3 Enterprise ignores the username (u) parameter in the request.

Use one of the following authentication schemes with clients that support Basic authentication or query parameters:

• Basic authentication
• Query string authentication

Basic authentication

Use the Authorization header with the Basic scheme to authenticate v1 API /query requests. When authenticating requests, InfluxDB 3 Enterprise checks that the password part of the decoded credential is an authorized token with read access to the database. InfluxDB 3 Enterprise ignores the username part of the decoded credential.

Syntax

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

Encode the [USERNAME]:DATABASE_TOKEN credential using base64 encoding, and then append the encoded string to the Authorization: Basic header.

Example

The following example shows how to use cURL with the Basic authentication scheme:

curl --get "https://localhost:8181/query" \
  --user "any:
DATABASE_TOKEN
" \
  --data-urlencode "db=
DATABASE_NAME
" \
  --data-urlencode "q=SELECT * FROM home"

Query string authentication

In the URL, pass the p query parameter to authenticate /query requests. When authenticating requests, InfluxDB 3 Enterprise checks that the p (password) value is an authorized token with read access to the database and ignores the u (username) parameter.

Syntax

https://localhost:8181/query/?u=any&p=DATABASE_TOKEN

Example

The following example shows how to use cURL with query string authentication:

curl --get "https://localhost:8181/query" \
  --data-urlencode "p=
DATABASE_TOKEN
" \
  --data-urlencode "db=
DATABASE_NAME
" \
  --data-urlencode "q=SELECT * FROM home"

Authenticate with a token scheme

Use the Authorization: Bearer or the Authorization: Token scheme to pass a token with read access to the database for authenticating v1 API /query requests.

Bearer and Token are equivalent in InfluxDB 3 Enterprise. The Token scheme is used in the InfluxDB 2.x API. Bearer is defined by the OAuth 2.0 Framework. Support for one or the other may vary across InfluxDB API clients.

Syntax

Authorization: Bearer DATABASE_TOKEN

Authorization: Token DATABASE_TOKEN

Examples

Use Bearer to authenticate a query request:

curl --get "https://localhost:8181/query" \
  --header "Authorization: Bearer 
DATABASE_TOKEN
" \
  --data-urlencode "db=
DATABASE_NAME
" \
  --data-urlencode "q=SELECT * FROM home"

Use Token to authenticate a query request:

curl --get "https://localhost:8181/query" \
  --header "Authorization: Token 
DATABASE_TOKEN
" \
  --data-urlencode "db=
DATABASE_NAME
" \
  --data-urlencode "q=SELECT * FROM home"

Query parameters

For InfluxDB 3 Enterprise v1 API /query requests, set parameters as listed in the following table:

Timestamp precision

Use one of the following values for timestamp precision:

• ns: nanoseconds
• us: microseconds
• ms: milliseconds
• s: seconds
• m: minutes
• h: hours

Replace the following configuration values:

• DATABASE_NAME: the name of the database to query
• DATABASE_TOKEN: your InfluxDB 3 Enterprise token with read access to the database

Return results as JSON or CSV

By default, the /query endpoint returns results in JSON, but it can also return results in CSV. To return results as CSV, include the Accept header with the application/csv or text/csv MIME type:

curl --get https://localhost:8181/query \
  --header "Authorization: Bearer 
DATABASE_TOKEN
" \
  --header "Accept: application/csv" \
  --data-urlencode "db=
DATABASE_NAME
" \
  --data-urlencode "q=SELECT * FROM home"