Use the InfluxDB v2 API with InfluxDB Cloud Dedicated

Use the InfluxDB v2 API /api/v2/write endpoint for new write workloads and existing v2 write workloads that you bring to {{% product-name %}}. Learn how to authenticate requests, adjust request parameters for existing v2 workloads, and find compatible tools for writing and querying data stored in an {{% product-name %}} 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 Cloud Dedicated. 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:

{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}

{{% get-shared-text "api/cloud-dedicated/bearer-auth-v2-write.sh" %}}

{{% /code-placeholders %}}

Use Token to authenticate a write request:

{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}

{{% get-shared-text "api/cloud-dedicated/token-auth-v2-write.sh" %}}

{{% /code-placeholders %}}

Replace the following:

• {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: your {{% product-name %}} database
• {{% code-placeholder-key %}}DATABASE_TOKEN{{% /code-placeholder-key %}}: a database token with sufficient permissions to the specified database

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 database 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, 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.

[!Warning]

influx CLI not supported

Don't use the influx CLI with {{% product-name %}}. While it may coincidentally work, it isn't officially supported.

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

{{% product-name %}} 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]

/api/v2/query not supported

The /api/v2/query API endpoint and associated tooling, such as the influx CLI and InfluxDB v2 client libraries, aren’t supported in {{% product-name %}}.