Documentation

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 Core with InfluxQL.

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

InfluxQL feature support

InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, see InfluxQL feature support.

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

Authenticate API requests

InfluxDB 3 Core 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

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 as the password credential. When authenticating requests to the v1 API /query endpoint, InfluxDB 3 Core checks that the password (p) value is an authorized token. InfluxDB 3 Core 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

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

Syntax
Authorization: Basic <base64-encoded [USERNAME]:DATABASE_TOKEN>
  • Copy
  • Fill window

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"
  • Copy
  • Fill window

Query string authentication

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

Syntax
https://localhost:8181/query/?u=any&p=DATABASE_TOKEN
  • Copy
  • Fill window
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"
  • Copy
  • Fill window

Authenticate with a token scheme

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

Bearer and Token are equivalent in InfluxDB 3 Core. 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
  • Copy
  • Fill window
Authorization: Token DATABASE_TOKEN
  • Copy
  • Fill window

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"
  • Copy
  • Fill window

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"
  • Copy
  • Fill window

Query parameters

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

ParameterAllowed inIgnoredValue
chunkedQuery stringHonoredReturns points in streamed batches instead of in a single response. If set to true, InfluxDB chunks responses by series or by every 10,000 points, whichever occurs first.
chunked_sizeQuery stringHonoredRequires chunked to be set to true. If set to a specific value, InfluxDB chunks responses by series or by this number of points.
db *Query stringHonoredDatabase name
epochQuery stringHonoredTimestamp precision
pQuery stringHonoredFor query string authentication, a token
prettyQuery stringIgnoredN/A
q *Query stringHonoredURL-encoded InfluxQL query
rpQuery stringHonored, but discouragedRetention policy
uQuery stringIgnoredFor query string authentication, any arbitrary string
AuthorizationHeaderHonoredBearer DATABASE_TOKEN, Token DATABASE_TOKEN, or Basic <base64 [USERNAME]:DATABASE_TOKEN>
* = Required

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 Core token

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"
  • Copy
  • Fill window

Was this page helpful?

Thank you for your feedback!


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

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: