Use the InfluxDB v2 API with InfluxDB Cloud Serverless

{{% product-name %}} is compatible with the InfluxDB v2 API /api/v2/write endpoint and existing InfluxDB 2.x tools and code. Use the InfluxDB v2 API for new write workloads and existing v2 write workloads that you bring to {{% product-name %}}.

InfluxDB v2 API endpoints won't work for managing resources or querying data in {{% product-name %}}. To query data, use the Flight+gRPC protocol or the InfluxDB v1 /query HTTP API endpoint and associated tools.

• Authenticate API requests
  • Authenticate with a token
• Responses
  • Error examples
• Write data
  • /api/v2/write parameters
  • Tools for writing to the v2 API
• Query data

Authenticate API requests

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

Authenticate with a token

Use the Authorization: Token scheme to pass an API token that has the necessary permissions for the operation.

The Token scheme is used in the InfluxDB 2.x API.

Syntax

Authorization: Token API_TOKEN

Examples

Use Token to authenticate a write request:

{{% code-placeholders "BUCKET_NAME|API_TOKEN" %}}

# Use the Token authentication scheme with /api/v2/write
curl --request post "https://{{< influxdb/host >}}/api/v2/write?bucket=BUCKET_NAME&precision=s" \
  --header "Authorization: Token API_TOKEN" \
  --data-binary 'home,room=kitchen temp=72 1463683075'

{{% /code-placeholders %}}

Replace the following:

• {{% code-placeholder-key %}}BUCKET_NAME{{% /code-placeholder-key %}}: your InfluxDB Cloud Serverless bucket
• {{% code-placeholder-key %}}API_TOKEN{{% /code-placeholder-key %}}: an API token with sufficient permissions to the specified bucket

Responses

InfluxDB HTTP API responses use standard HTTP status codes. The response body for partial writes and errors contains a JSON object with code and message properties that describe the error. Response body messages may differ across {{% product-name %}} v1 API, v2 API, InfluxDB Cloud, and InfluxDB OSS.

Error examples

• Missing bucket value

  httpCopy

  400 Bad Request
  

  jsonCopy

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

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

• Failed to deserialize org/bucket/precision

  httpCopy

  400 Bad Request
  

  jsonCopy

  { "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

Use the InfluxDB v2 API /api/v2/write endpoint for new write workloads and existing v2 workloads.

{{% api-endpoint endpoint="https://{{< influxdb/host >}}/api/v2/write" method="post"%}}

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

/api/v2/write parameters

For {{% product-name %}} v2 API /api/v2/write requests, set parameters as listed in the following table:

{{% caption %}}{{% req " *" %}} = {{% req "Required" %}}{{% /caption %}}

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 {{% product-name %}} /api/v2/write endpoint:

• Telegraf
• Interactive clients
• Client libraries

Telegraf

See how to configure Telegraf to write to {{% product-name %}}.

Interactive clients

To test InfluxDB v2 API writes interactively from the command line, 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 3 provides the following protocols for executing a query:

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

[!Note]

Tools to execute queries

{{% product-name %}} supports many different tools for querying data, including:

• influx3 data CLI
• InfluxDB 3 client libraries
• Flight clients
• Superset
• Grafana
• InfluxQL with InfluxDB v1 HTTP API
• Chronograf

[!Warning]

Avoid using /api/v2/query

Avoid using the /api/v2/query API endpoint in {{% product-name %}} and associated tooling, such as the influx query CLI command and InfluxDB v2 client libraries. You can't use SQL or InfluxQL with these tools.