Use the InfluxDB v2 API with InfluxDB Clustered

Use the InfluxDB v2 API /api/v2/write endpoint for new write workloads and existing v2 write workloads that you bring to InfluxDB Clustered. Learn how to authenticate requests, adjust request parameters for existing v2 workloads, and find compatible tools for writing and querying data stored in an InfluxDB Clustered database.

For help finding the best workflow for your situation, contact Support.

• Authenticate API requests
  • Authenticate with a token
    • Syntax
    • Examples
• Responses
  • Error examples
• Write data
  • /api/v2/write parameters
    • Timestamp precision
  • Tools for writing to the v2 API
    • Telegraf
    • Interactive clients
    • influx CLI not supported
    • Client libraries
• Query data
  • Tools to execute queries
  • /api/v2/query not supported

Authenticate API requests

InfluxDB API endpoints require each request to be authenticated with a database token.

Authenticate with a token

Use the Authorization: Bearer scheme or the Authorization: Token scheme to pass a database token that has the necessary permissions for the operation.

Bearer and Token are equivalent in InfluxDB Clustered. 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 write request:

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

curl --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 1641024000'

Replace the following:

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

Responses

InfluxDB API responses use standard HTTP status codes. For successful writes, InfluxDB responds with a 204 No Content status code. Error responses contain a JSON object with code and message properties that describe the error. Response body messages may differ across InfluxDB Clustered v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS.

Error examples

• Missing bucket value

  400 Bad Request
  

  { "code": "invalid",
    "message":"missing bucket value"
  }
  

  The ?bucket= parameter value is missing in the request. Provide the database name.

• Failed to deserialize org/bucket/precision

  400 Bad Request
  

  { "code":"invalid",
    "message":"failed to deserialize org/bucket/precision in request: unknown variant `u`, expected one of `s`, `ms`, `us`, `ns`"
  }
  

  The ?precision= parameter contains an unknown value. Provide a timestamp precision.

Write data

We recommend using the InfluxDB v2 API /api/v2/write endpoint for new write workloads and existing v2 workloads.

POST https://cluster-host.com/api/v2/write

• /api/v2/write parameters
• Tools for writing to the v2 API

/api/v2/write parameters

For InfluxDB Clustered v2 API /api/v2/write requests, set parameters as listed in the following table:

Timestamp precision

Use one of the following precision values in v2 API /api/v2/write requests:

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

Tools for writing to the v2 API

The following tools work with the InfluxDB Clustered /api/v2/write endpoint:

• Telegraf
• Interactive clients
• Client libraries

Telegraf

See how to configure Telegraf to write to InfluxDB Clustered.

Interactive clients

To test InfluxDB v2 API writes interactively, use the influx3 data CLI or common HTTP clients such as cURL and Postman.

To setup and start using interactive clients, see the Get started tutorial.

Client libraries

InfluxDB v3 client libraries and v2 client libraries can write data to the InfluxDB v2 API /api/v2/write endpoint. Client libraries are language-specific packages that integrate InfluxDB APIs with your application.

To setup and start using client libraries, see the Get started tutorial.

Query data

InfluxDB Clustered provides the following protocols for executing a query:

• Flight+gRPC request that contains an SQL or InfluxQL query. To learn how to query InfluxDB Clustered using Flight and SQL, see the Get started tutorial.
• InfluxDB v1 API /query request that contains an InfluxQL query.

/api/v2/query not supported

The /api/v2/query API endpoint and associated tooling aren’t supported in InfluxDB Clustered.