Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ username and password to authenticate database reads and writes by passing a
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).
{{% product-name %}} ignores the `username` (`u`) parameter in the request.

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)):
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)):

- [Basic authentication](#basic-authentication)
- [Query string authentication](#query-string-authentication)
Expand Down Expand Up @@ -260,7 +260,7 @@ Write data with your existing workloads that already use the InfluxDB v1 or v1.x

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

- [`/api/v2/write` parameters](#v1-api-write-parameters)
- [`/write` parameters](#v1-api-write-parameters)
- [Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api)

#### v1 API /write parameters
Expand Down Expand Up @@ -302,7 +302,7 @@ The following tools work with the {{% product-name %}} `/write` endpoint:
#### Telegraf

If you have existing v1 workloads that use Telegraf,
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.
you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](/telegraf/v1/output-plugins/influxdb/) to write data.

> [!Note]
> 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.
Expand Down Expand Up @@ -344,7 +344,7 @@ Replace the following:

`influx_uint_support`: supported in InfluxDB 3.

For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub.
For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub.

#### Interactive clients

Expand All @@ -355,7 +355,7 @@ Include the following in your request:
- A `db` query string parameter with the name of the database to write to.
- A request body that contains a string of data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) syntax.
- A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) in
one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token).
one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token-scheme).
- Optional [parameters](#v1-api-write-parameters).

The following example shows how to use the **cURL** command line tool and the {{% product-name %}} v1 API to write line protocol data to a database:
Expand Down
4 changes: 2 additions & 2 deletions content/influxdb3/cloud-dedicated/write-data/csv/telegraf.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ metrics from different sources and writes them to specified destinations.
## Configure Telegraf to write to InfluxDB

To send data to {{< product-name >}}, enable the
[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md)
[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/)
in the `telegraf.conf`.

{{% code-placeholders "DATABASE_NAME" %}}
Expand Down Expand Up @@ -145,4 +145,4 @@ The preceding examples describe Telegraf configurations necessary for writing to
The output plugin provides several other options for configuring the Telegraf client:

- `influx_uint_support`: supported by the InfluxDB 3 storage engine.
- See [`influxdb_v2` plugin options](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) on GitHub.
- See [`influxdb_v2` plugin options](/telegraf/v1/output-plugins/influxdb_v2/) on GitHub.
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ To add any of the available [Telegraf plugins](/telegraf/v1/plugins/), follow th
### Enable and configure the InfluxDB v2 output plugin

To send data to {{< product-name >}}, enable the
[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md)
[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/)
in the `telegraf.conf`.

{{% code-placeholders "DATABASE_NAME" %}}
Expand Down Expand Up @@ -124,7 +124,7 @@ The name of the {{% product-name %}} database to write data to.

`influx_uint_support`: supported in InfluxDB 3.

For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub.
For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub.

## Start Telegraf

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ username and password to authenticate bucket reads and writes by passing an [API
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/).
{{% product-name %}} ignores the `username` (`u`) parameter in the request.

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)):
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)):

- [Basic authentication](#basic-authentication)
- [Query string authentication](#query-string-authentication)
Expand Down Expand Up @@ -144,8 +144,8 @@ curl --get "https://{{< influxdb/host >}}/query" \

Replace the following:

- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket

### Authenticate with a token scheme
Expand Down Expand Up @@ -187,8 +187,8 @@ influx bucket delete -n DATABASE_NAME/RETENTION_POLICY_NAME

Replace the following:

- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets)
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket

## Responses
Expand Down Expand Up @@ -228,7 +228,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In
```

The `?precision=` parameter contains an unknown value.
Provide a [timestamp precision](#timestamp-precision).
Provide a [timestamp precision]/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision).

## Map v1 databases and retention policies to buckets

Expand Down Expand Up @@ -336,7 +336,7 @@ Include the following:

{{< req type="key" >}}

- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization).
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket.
- {{< req "\*" >}} the **database name** to map
- {{< req "\*" >}} the **retention policy** name to map
- {{< req "\*" >}} the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to
Expand Down Expand Up @@ -376,7 +376,7 @@ influx v1 dbrp delete --id $test_dbrp

Replace the following:

- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the database name to map to the bucket
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: the retention policy name to map to the bucket
- {{% code-placeholder-key %}}`BUCKET_ID`{{% /code-placeholder-key %}}: the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/) to map to
Expand All @@ -395,7 +395,7 @@ Include the following:

- **Request method:** `POST`
- **Headers:**
- **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- **Content-type:** `application/json`
- **Request body:** JSON object with the following fields:

Expand Down Expand Up @@ -485,7 +485,7 @@ Include the following:

- **Request method:** `GET`
- **Headers:**
- **Authorization:** `Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- **Authorization:** `Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- **Query parameters:**
{{< req type="key" >}}
- {{< req "\*" >}} **orgID:** your [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id)
Expand Down Expand Up @@ -545,7 +545,7 @@ Use the [`influx v1 dbrp update` command](/influxdb3/cloud-serverless/reference/
to update a DBRP mapping.
Include the following:

- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- **DBRP mapping ID** to update
- Optional: **Retention policy** name to update to
- Optional: **Default flag** to set the retention policy as the [default DBRP mapping](#default-dbrp) for the database name.
Expand Down Expand Up @@ -577,7 +577,7 @@ influx v1 dbrp update \

Replace the following:

- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket

Expand All @@ -596,7 +596,7 @@ Include the following:

- **Request method:** `PATCH`
- **Headers:**
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- **Path parameters:**
- {{< req "\*" >}} **id:** the DBRP mapping ID to update
- **Query parameters:**
Expand All @@ -622,7 +622,7 @@ curl --request PATCH \

Replace the following:

- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket

Expand All @@ -648,7 +648,7 @@ Include the following:

{{< req type="key" >}}

- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- {{< req "\*" >}} **DBRP mapping ID** to delete


Expand Down Expand Up @@ -689,7 +689,7 @@ Include the following:

- **Request method:** `DELETE`
- **Headers:**
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- **Path parameters:**
- {{< req "\*" >}} **id:** DBRP mapping ID to update
- **Query parameters:**
Expand All @@ -708,7 +708,7 @@ curl --request DELETE \

Replace the following:

- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
- {{% code-placeholder-key %}}`ORG_ID`{{% /code-placeholder-key %}}: the [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id)

Expand Down
Loading
Loading