You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ username and password to authenticate database reads and writes by passing a
78
78
When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens).
79
79
{{% product-name %}} ignores the `username` (`u`) parameter in the request.
80
80
81
-
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)):
81
+
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token-scheme)):
-[Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api)
265
265
266
266
#### v1 API /write parameters
@@ -302,7 +302,7 @@ The following tools work with the {{% product-name %}} `/write` endpoint:
302
302
#### Telegraf
303
303
304
304
If you have existing v1 workloads that use Telegraf,
305
-
you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data.
305
+
you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](/telegraf/v1/output-plugins/influxdb/) to write data.
306
306
307
307
> [!Note]
308
308
> See how to [use Telegraf and the v2 API](/influxdb3/cloud-dedicated/write-data/use-telegraf/) for new workloads that don't already use the v1 API.
@@ -344,7 +344,7 @@ Replace the following:
344
344
345
345
`influx_uint_support`: supported in InfluxDB 3.
346
346
347
-
For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub.
347
+
For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub.
348
348
349
349
#### Interactive clients
350
350
@@ -355,7 +355,7 @@ Include the following in your request:
355
355
- A `db` query string parameter with the name of the database to write to.
356
356
- A request body that contains a string of data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) syntax.
357
357
- A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) in
358
-
one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token).
358
+
one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token-scheme).
Copy file name to clipboardExpand all lines: content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ username and password to authenticate bucket reads and writes by passing an [API
64
64
When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [API token](/influxdb3/cloud-serverless/admin/tokens/).
65
65
{{% product-name %}} ignores the `username` (`u`) parameter in the request.
66
66
67
-
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)):
67
+
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token-scheme)):
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets)
148
-
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets)
147
+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets)
148
+
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets)
149
149
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets)
191
-
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets)
190
+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets)
191
+
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets)
192
192
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket
193
193
194
194
## Responses
@@ -228,7 +228,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In
228
228
```
229
229
230
230
The `?precision=` parameter contains an unknown value.
231
-
Provide a [timestamp precision](#timestamp-precision).
231
+
Provide a [timestamp precision]/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision).
232
232
233
233
## Map v1 databases and retention policies to buckets
234
234
@@ -336,7 +336,7 @@ Include the following:
336
336
337
337
{{< req type="key" >}}
338
338
339
-
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization).
339
+
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket.
340
340
- {{< req "\*" >}} the **database name** to map
341
341
- {{< req "\*" >}} the **retention policy** name to map
342
342
- {{< req "\*" >}} the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
379
+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
380
380
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the database name to map to the bucket
381
381
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: the retention policy name to map to the bucket
382
382
- {{% code-placeholder-key %}}`BUCKET_ID`{{% /code-placeholder-key %}}: the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/) to map to
@@ -395,7 +395,7 @@ Include the following:
395
395
396
396
-**Request method:**`POST`
397
397
-**Headers:**
398
-
-**Authorization:**`Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
398
+
-**Authorization:**`Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
399
399
-**Content-type:**`application/json`
400
400
-**Request body:** JSON object with the following fields:
401
401
@@ -485,7 +485,7 @@ Include the following:
485
485
486
486
-**Request method:**`GET`
487
487
-**Headers:**
488
-
-**Authorization:**`Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
488
+
-**Authorization:**`Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
489
489
-**Query parameters:**
490
490
{{< req type="key" >}}
491
491
- {{< req "\*" >}} **orgID:** your [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id)
@@ -545,7 +545,7 @@ Use the [`influx v1 dbrp update` command](/influxdb3/cloud-serverless/reference/
545
545
to update a DBRP mapping.
546
546
Include the following:
547
547
548
-
- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
548
+
- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
549
549
-**DBRP mapping ID** to update
550
550
- Optional: **Retention policy** name to update to
551
551
- Optional: **Default flag** to set the retention policy as the [default DBRP mapping](#default-dbrp) for the database name.
@@ -577,7 +577,7 @@ influx v1 dbrp update \
577
577
578
578
Replace the following:
579
579
580
-
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
580
+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
581
581
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
582
582
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket
583
583
@@ -596,7 +596,7 @@ Include the following:
596
596
597
597
-**Request method:**`PATCH`
598
598
-**Headers:**
599
-
- {{< req "\*" >}} the **Authorization:**`Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
599
+
- {{< req "\*" >}} the **Authorization:**`Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
600
600
-**Path parameters:**
601
601
- {{< req "\*" >}} **id:** the DBRP mapping ID to update
602
602
-**Query parameters:**
@@ -622,7 +622,7 @@ curl --request PATCH \
622
622
623
623
Replace the following:
624
624
625
-
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
625
+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
626
626
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
627
627
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket
628
628
@@ -648,7 +648,7 @@ Include the following:
648
648
649
649
{{< req type="key" >}}
650
650
651
-
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
651
+
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
652
652
- {{< req "\*" >}} **DBRP mapping ID** to delete
653
653
654
654
@@ -689,7 +689,7 @@ Include the following:
689
689
690
690
-**Request method:**`DELETE`
691
691
-**Headers:**
692
-
- {{< req "\*" >}} the **Authorization:**`Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
692
+
- {{< req "\*" >}} the **Authorization:**`Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
693
693
-**Path parameters:**
694
694
- {{< req "\*" >}} **id:** DBRP mapping ID to update
695
695
-**Query parameters:**
@@ -708,7 +708,7 @@ curl --request DELETE \
708
708
709
709
Replace the following:
710
710
711
-
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
711
+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
712
712
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
713
713
- {{% code-placeholder-key %}}`ORG_ID`{{% /code-placeholder-key %}}: the [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id)
0 commit comments