Skip to content

Commit 43aebf0

Browse files
committed
fix(v1): update client library recommendations for v1, v3
1 parent 180c82d commit 43aebf0

File tree

1 file changed

+41
-22
lines changed
  • content/influxdb/v1/tools

1 file changed

+41
-22
lines changed

content/influxdb/v1/tools/api.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,43 +13,62 @@ v2: /influxdb/v2/reference/api/
1313
---
1414

1515
The InfluxDB API provides a simple way to interact with the database.
16-
It uses HTTP response codes, HTTP authentication, JWT Tokens, and basic authentication, and responses are returned in JSON.
16+
It uses HTTP authentication and JWT Tokens.
17+
Responses use standard HTTP response codes and JSON format.
18+
19+
To send API requests, you can use
20+
the [InfluxDB v1 client libraries](/influxdb/v1/tools/api_client_libraries/),
21+
the [InfluxDB v2 client libraries](/influxdb/v1/tools/api_client_libraries/),
22+
[Telegraf](https://docs.influxdata.com/telegraf/v1/),
23+
or the client of your choice.
24+
25+
If you're getting started with InfluxDB v1, we recommend using the
26+
InfluxDB v1 client libraries and InfluxQL for [InfluxDB v3 compatibility](#influxdb-v3-compatibility).
1727

1828
The following sections assume your InfluxDB instance is running on `localhost`
1929
port `8086` and HTTPS is not enabled.
2030
Those settings [are configurable](/influxdb/v1/administration/config/#http-endpoints-settings).
2131

22-
- [InfluxDB 2.0 API compatibility endpoints](#influxdb-2-0-api-compatibility-endpoints)
23-
- [InfluxDB 1.x HTTP endpoints](#influxdb-1-x-http-endpoints)
32+
- [InfluxDB v3 compatibility](#influxdb-v3-compatibility)
33+
- [InfluxDB 2.x API compatibility endpoints](#influxdb-2x-api-compatibility-endpoints)
34+
- [InfluxDB 1.x HTTP endpoints](#influxdb-1x-http-endpoints)
35+
36+
## InfluxDB v3 compatibility
37+
38+
InfluxDB v3 is InfluxDB’s next generation that allows
39+
infinite series cardinality without impact on overall database performance, and
40+
brings native SQL support and improved InfluxQL performance.
41+
42+
InfluxDB v3 supports the v1 `/write` and `/query` HTTP API endpoints.
43+
InfluxDB v3 isn't optimized for Flux.
2444

25-
## InfluxDB 2.0 API compatibility endpoints
45+
If you're getting started with InfluxDB v1, we recommend using the
46+
InfluxDB v1 client libraries and InfluxQL.
47+
When you're ready, you can migrate to InfluxDB v3 and continue using the v1 client
48+
libraries as you gradually move your query workloads to use the v3 client libraries
49+
(and the v3 Flight API).
2650

27-
InfluxDB 1.8.0 introduced forward compatibility APIs for InfluxDB 2.0.
28-
There are multiple reasons for introducing these:
51+
For more information, see [API compatibility and migration guides for InfluxDB v3](/influxdb/cloud-dedicated/guides).
2952

30-
- The latest [InfluxDB client libraries](/influxdb/v1/tools/api_client_libraries/)
31-
are built for the InfluxDB 2.0 API, but now also work with **InfluxDB 1.8.0+**.
32-
- InfluxDB Cloud is a generally available service across multiple cloud service providers and regions
33-
that is fully compatible with the **latest** client libraries.
53+
## InfluxDB 2.x API compatibility endpoints
3454

35-
If you are just getting started with InfluxDB 1.x today, we recommend adopting
36-
the [latest client libraries](/influxdb/v1/tools/api_client_libraries/).
37-
They allow you to easily move from InfluxDB 1.x to InfluxDB 2.0 Cloud or open source,
38-
(when you are ready).
55+
InfluxDB 1.8.0 introduced forward compatibility APIs for InfluxDB v2.
56+
[InfluxDB v2 client libraries](/influxdb/v1/tools/api_client_libraries/)
57+
are built for the InfluxDB v2 API, but also work with **InfluxDB 1.8+**.
3958

40-
The following forward compatible APIs are available:
59+
The following v2 compatible APIs are available:
4160

4261
| Endpoint | Description |
4362
|:---------- |:---------- |
44-
| [/api/v2/query](#api-v2-query-http-endpoint) | Query data in InfluxDB 1.8.0+ using the InfluxDB 2.0 API and [Flux](/flux/latest/) |
45-
| [/api/v2/write](#api-v2-write-http-endpoint) | Write data to InfluxDB 1.8.0+ using the InfluxDB 2.0 API _(compatible with InfluxDB 2.0 client libraries)_ |
63+
| [/api/v2/query](#api-v2-query-http-endpoint) | Query data in InfluxDB 1.8.0+ using the InfluxDB v2 API and [Flux](/flux/latest/) |
64+
| [/api/v2/write](#api-v2-write-http-endpoint) | Write data to InfluxDB 1.8.0+ using the InfluxDB v2 API _(compatible with InfluxDB v2 client libraries)_ |
4665
| [/health](#health-http-endpoint) | Check the health of your InfluxDB instance |
4766

4867
### `/api/v2/query/` HTTP endpoint
4968

5069
The `/api/v2/query` endpoint accepts `POST` HTTP requests.
51-
Use this endpoint to query data using [Flux](/influxdb/v1/flux/) and [InfluxDB 2.0 client libraries](/influxdb/v2/api-guide/client-libraries/).
52-
Flux is the primary language for working with data in InfluxDB 2.0.
70+
Use this endpoint to query data using [Flux](/influxdb/v1/flux/) and [InfluxDB v2 client libraries](/influxdb/v2/api-guide/client-libraries/).
71+
Flux is the primary language for working with data in InfluxDB v2.
5372

5473
**Include the following HTTP headers:**
5574

@@ -90,11 +109,11 @@ curl -XPOST localhost:8086/api/v2/query -sS \
90109
### `/api/v2/write/` HTTP endpoint
91110

92111
The `/api/v2/write` endpoint accepts `POST` HTTP requests.
93-
Use this endpoint to write to an InfluxDB 1.8.0+ database using [InfluxDB 2.0 client libraries](/influxdb/v2/api-guide/client-libraries/).
112+
Use this endpoint to write to an InfluxDB 1.8.0+ database using [InfluxDB v2 client libraries](/influxdb/v2/api-guide/client-libraries/).
94113

95114
Both InfluxDB 1.x and 2.0 APIs support the same line protocol format for raw time series data.
96115
For the purposes of writing data, the APIs differ only in the URL parameters and request headers.
97-
InfluxDB 2.0 uses [organizations](/influxdb/v2/reference/glossary/#organization)
116+
InfluxDB v2 uses [organizations](/influxdb/v2/reference/glossary/#organization)
98117
and [buckets](/influxdb/v2/reference/glossary/#bucket)
99118
instead of databases and retention policies.
100119
The `/api/v2/write` endpoint maps the supplied version 1.8 database and retention policy to a bucket.
@@ -112,7 +131,7 @@ The `/api/v2/write` endpoint maps the supplied version 1.8 database and retentio
112131

113132
**Include the following HTTP header:**
114133

115-
- `Authorization`: In InfluxDB 2.0 uses [API Tokens](/influxdb/v2/admin/tokens/)
134+
- `Authorization`: In InfluxDB v2 uses [API Tokens](/influxdb/v2/admin/tokens/)
116135
to access the platform and all its capabilities.
117136
InfluxDB v1.x uses a username and password combination when accessing the HTTP APIs.
118137
Use the Token schema to provide your InfluxDB 1.x username and password separated by a colon (`:`).

0 commit comments

Comments
 (0)