--- title: Use the InfluxDB v2 API with InfluxDB Cloud Serverless description: Use the InfluxDB v2 API for new write workloads and existing v2 write workloads. InfluxDB Cloud Serverless 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/cloud-serverless/guides/api-compatibility/v2/ estimated_tokens: 3116 product: InfluxDB Cloud Serverless version: cloud-serverless --- # Use the InfluxDB v2 API with InfluxDB Cloud Serverless InfluxDB Cloud Serverless 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 InfluxDB Cloud Serverless. InfluxDB v2 API endpoints won’t work for managing resources or querying data in InfluxDB Cloud Serverless. To query data, use the *Flight+gRPC* protocol or the InfluxDB v1 `/query` HTTP API endpoint and [associated tools](#tools-to-execute-queries). - [Authenticate API requests](#authenticate-api-requests) - [Authenticate with a token](#authenticate-with-a-token) - [Responses](#responses) - [Error examples](#error-examples) - [Write data](#write-data) - [/api/v2/write parameters](#apiv2write-parameters) - [Tools for writing to the v2 API](#tools-for-writing-to-the-v2-api) - [Query data](#query-data) ## Authenticate API requests InfluxDB API endpoints require each request to be authenticated with an [API token](/influxdb3/cloud-serverless/admin/tokens/). ### Authenticate with a token Use the `Authorization: Token` scheme to pass an [API token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions for the operation. The `Token` scheme is used in the InfluxDB 2.x API. #### Syntax ```http Authorization: Token API_TOKEN ``` #### Examples Use `Token` to authenticate a write request: ```sh # Use the Token authentication scheme with /api/v2/write curl --request post "https://cloud2.influxdata.com/api/v2/write?bucket=BUCKET_NAME&precision=s" \ --header "Authorization: Token API_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' ``` Replace the following: - `BUCKET_NAME`: your InfluxDB Cloud Serverless [bucket](/influxdb3/cloud-serverless/admin/buckets/) - `API_TOKEN`: an [API token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket ## Responses InfluxDB HTTP API responses use standard [HTTP status codes](/influxdb3/cloud-serverless/api/response-codes/). The response body for [partial writes](/influxdb3/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points) and errors contains a JSON object with `code` and `message` properties that describe the error. Response body messages may differ across InfluxDB Cloud Serverless 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 [bucket](/influxdb3/cloud-serverless/admin/buckets/) 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 Use the InfluxDB v2 API `/api/v2/write` endpoint for new write workloads and existing v2 workloads. POST https://cloud2.influxdata.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 Cloud Serverless 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 | Token API_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 Cloud Serverless `/api/v2/write` endpoint: - [Telegraf](#telegraf) - [Interactive clients](#interactive-clients) - [Client libraries](#client-libraries) #### Telegraf See how to [configure Telegraf](/influxdb3/cloud-serverless/write-data/use-telegraf/configure/) to write to InfluxDB Cloud Serverless. #### Interactive clients To test InfluxDB v2 API writes interactively from the command line, 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/cloud-serverless/get-started/) tutorial. #### Client libraries InfluxDB [v3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [v2 client libraries](/influxdb3/cloud-serverless/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/cloud-serverless/get-started/) tutorial. ## Query data InfluxDB 3 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 Cloud Serverless using Flight and SQL, see the [Get started](/influxdb3/cloud-serverless/get-started/) tutorial. - InfluxDB v1 API `/query` request that contains an InfluxQL query. #### Tools to execute queries InfluxDB Cloud Serverless supports many different tools for querying data, including: - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli) - [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) - [Flight clients](/influxdb3/cloud-serverless/reference/client-libraries/flight/) - [Superset](/influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/) - [Grafana](/influxdb3/cloud-serverless/query-data/sql/execute-queries/grafana/) - [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/primers/api/v1/#query-using-the-v1-api) - [Chronograf](/chronograf/v1/) #### Avoid using /api/v2/query Avoid using the `/api/v2/query` API endpoint in InfluxDB Cloud Serverless 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. #### Related - [Query data with SQL](/influxdb3/cloud-serverless/query-data/sql/) - [Query data with InfluxQL](/influxdb3/cloud-serverless/query-data/influxql/) - [Write data to InfluxDB](/influxdb3/cloud-serverless/write-data/) - [Configure Telegraf for InfluxDB](/influxdb3/cloud-serverless/write-data/use-telegraf/configure/) - [InfluxDB API client libraries](/influxdb3/cloud-serverless/reference/client-libraries/)