Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/influxdb3/clustered/guides/api-compatibility/v2/_index.md

9.2 KiB
Raw Permalink Blame History

title list_title description weight menu influxdb3/clustered/tags aliases related
Use the InfluxDB v2 API with InfluxDB Clustered InfluxDB v2 API compatibility Use the InfluxDB v2 API for new write workloads and existing v2 write workloads. InfluxDB Clustered is compatible with the InfluxDB v2 API `/api/v2/write` endpoint and existing InfluxDB 2.x tools and code. 1
influxdb3_clustered
parent name
API compatibility v2 API
write
line protocol
/influxdb3/clustered/primers/api/v2/
/influxdb3/clustered/query-data/sql/
/influxdb3/clustered/query-data/influxql/
/influxdb3/clustered/write-data/
/influxdb3/clustered/write-data/use-telegraf/configure/
/influxdb3/clustered/reference/api/
/influxdb3/clustered/reference/client-libraries/

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

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:

{{% influxdb/custom-timestamps %}} {{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}

curl --request post 'https://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_NAME&precision=s' \
  --header 'Authorization: Bearer DATABASE_TOKEN' \
  --data-binary 'home,room=kitchen temp=72 1641024000'

{{% /code-placeholders %}}

Use Token to authenticate a write request:

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

curl --request post "https://{{< influxdb/host >}}/api/v2/write?bucket=DATABASE_NAME&precision=s" \
  --header "Authorization: Token DATABASE_TOKEN" \
  --data-binary 'home,room=kitchen temp=72 1641024000'

{{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}}

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

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

/api/v2/write parameters

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

Parameter Allowed in Ignored Value
org Query string Ignored Non-zero-length string (ignored, but can't be empty)
orgID Query string Ignored N/A
bucket {{% req " *" %}} Query string Honored Database name
precision Query string Honored Timestamp precision
Accept Header Honored User-defined
Authorization {{% req " *" %}} Header Honored Bearer DATABASE_TOKEN or Token DATABASE_TOKEN
Content-Encoding Header Honored gzip (compressed data) or identity (uncompressed)
Content-Length Header Honored User-defined
Content-Type Header Ignored N/A (only supports line protocol)
Zap-Trace-Span Header Ignored

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

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.

{{% warn %}}

influx CLI not supported

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

{{% /warn %}}

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:

{{% /note %}}

{{% warn %}}

/api/v2/query not supported

The InfluxDB API /api/v2/query endpoint can't query an {{% product-name omit=" Clustered" %}} cluster. 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 %}}.

{{% /warn %}}