--- title: Use the InfluxDB v2 API with InfluxDB Clustered description: 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. url: https://docs.influxdata.com/influxdb3/clustered/guides/api-compatibility/v2/ estimated_tokens: 3739 product: InfluxDB Clustered version: clustered --- # 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](mailto:support@influxdata.com). - [Authenticate API requests](#authenticate-api-requests) - [Authenticate with a token](#authenticate-with-a-token) - [Syntax](#syntax) - [Examples](#examples) - [Responses](#responses) - [Error examples](#error-examples) - [Write data](#write-data) - [/api/v2/write parameters](#apiv2write-parameters) - [Timestamp precision](#timestamp-precision) - [Tools for writing to the v2 API](#tools-for-writing-to-the-v2-api) - [Telegraf](#telegraf) - [Interactive clients](#interactive-clients) - [influx CLI not supported](#influx-cli-not-supported) - [Client libraries](#client-libraries) - [Query data](#query-data) - [Tools to execute queries](#tools-to-execute-queries) - [/api/v2/query not supported](#apiv2query-not-supported) ## Authenticate API requests InfluxDB API endpoints require each request to be authenticated with a [database token](/influxdb3/clustered/admin/tokens/#database-tokens). ### Authenticate with a token Use the `Authorization: Bearer` scheme or the `Authorization: Token` scheme to pass a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) 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](https://www.rfc-editor.org/rfc/rfc6750#page-14). Support for one or the other may vary across InfluxDB API clients. #### Syntax ```http Authorization: Bearer DATABASE_TOKEN ``` ```http Authorization: Token DATABASE_TOKEN ``` #### Examples Use `Bearer` to authenticate a write request: ```sh curl --request 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' ``` Use `Token` to authenticate a write request: ```sh curl --request 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](/influxdb3/clustered/admin/databases/) - `DATABASE_TOKEN`: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) 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** ```http 400 Bad Request ``` ```json { "code": "invalid", "message":"missing bucket value" } ``` The `?bucket=` parameter value is missing in the request. Provide the [database](/influxdb3/clustered/admin/databases/) name. - **Failed to deserialize org/bucket/precision** ```http 400 Bad Request ``` ```json { "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](#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](#apiv2write-parameters) - [Tools for writing to the v2 API](#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: | 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 * | Query string | Honored | Database name | | precision | Query string | Honored | Timestamp precision | | Accept | Header | Honored | User-defined | | Authorization * | 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 | | \* = Required #### 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](#telegraf) - [Interactive clients](#interactive-clients) - [Client libraries](#client-libraries) #### Telegraf See how to [configure Telegraf](/influxdb3/clustered/write-data/use-telegraf/configure/) to write to InfluxDB Clustered. #### Interactive clients To test InfluxDB v2 API writes interactively, use the [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) or common HTTP clients such as cURL and Postman. To setup and start using interactive clients, see the [Get started](/influxdb3/clustered/get-started/) tutorial. #### influx CLI not supported Don’t use the `influx` CLI with InfluxDB Clustered. While it may coincidentally work, it isn’t officially supported. #### Client libraries InfluxDB [v3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [v2 client libraries](/influxdb3/clustered/reference/client-libraries/v2/) 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](/influxdb3/clustered/get-started/) tutorial. ## Query data InfluxDB Clustered provides the following protocols for executing a query: - [Flight+gRPC](https://arrow.apache.org/docs/format/Flight.html) request that contains an SQL or InfluxQL query. To learn how to query InfluxDB Clustered using Flight and SQL, see the [Get started](/influxdb3/clustered/get-started/) tutorial. - InfluxDB v1 API `/query` request that contains an InfluxQL query. #### Tools to execute queries InfluxDB Clustered supports many different tools for querying data, including: - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) - [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) - [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) - [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) - [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) - [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/primers/api/v1/#query-using-the-v1-api) - [Chronograf](/chronograf/v1/) #### /api/v2/query not supported The InfluxDB API `/api/v2/query` endpoint can’t query an InfluxDB cluster. The `/api/v2/query` API endpoint and associated tooling, such as the `influx` CLI and InfluxDB v2 client libraries, **aren’t** supported in InfluxDB Clustered. #### Related - [Query data with SQL](/influxdb3/clustered/query-data/sql/) - [Query data with InfluxQL](/influxdb3/clustered/query-data/influxql/) - [Write data to InfluxDB Clustered](/influxdb3/clustered/write-data/) - [Configure Telegraf for InfluxDB](/influxdb3/clustered/write-data/use-telegraf/configure/) - [InfluxDB API client libraries](/influxdb3/clustered/reference/client-libraries/) [write](/influxdb3/clustered/tags/write/) [line protocol](/influxdb3/clustered/tags/line-protocol/)