8.2 KiB
title | list_title | description | menu | weight | influxdb/v2/tags | list_code_example | related | alias | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
/write 1.x compatibility API | /write | The `/write` 1.x compatibility endpoint writes data to InfluxDB Cloud and InfluxDB OSS 2.x using patterns from the InfluxDB 1.x `/write` API endpoint. |
|
301 |
|
<pre> <span class="api post">POST</span> http://localhost:8086/write </pre> |
|
|
The /write
1.x compatibility endpoint writes data to InfluxDB Cloud and InfluxDB OSS {{< current-version >}}
using patterns from the InfluxDB 1.x /write
API endpoint.
Use the POST
request method to write line protocol
to the /write
endpoint.
POST http://localhost:8086/write
{{% cloud-only %}}
{{% note %}}
If you have an existing bucket that doesn't follow the database/retention-policy
naming convention,
you must manually create a database and retention policy mapping
to write data to that bucket with the /write
compatibility API.
{{% /note %}}
{{% /cloud-only %}}
Authentication
{{% oss-only %}}
Use one of the following authentication methods:
- token authentication
- basic authentication with username and password
- query string authentication with username and password
For more information, see Authentication.
{{% /oss-only %}}
{{% cloud-only %}}
{{% api/v1-compat/cloud/authentication %}}
{{% /cloud-only %}}
Request body
Include your line protocol in the request body.
Binary encode the line protocol to prevent unintended formatting.
The examples below use the curl --data-binary
flag to binary
encode the line protocol.
Query string parameters
{{% oss-only %}}
u
(Optional) The 1.x username to authenticate the request. See query string authentication.
p
(Optional) The 1.x password to authenticate the request. See query string authentication.
{{% /oss-only %}}
{{% cloud-only %}}
u
(Optional) The InfluxDB Cloud username to authenticate the request. See query string authentication.
p
(Optional) The InfluxDB Cloud API token to authenticate the request. See query string authentication.
{{% /cloud-only %}}
db
({{< req >}}) The database to write data to. This is mapped to an InfluxDB bucket. See Database and retention policy mapping.
rp
The retention policy to write data to. This is mapped to an InfluxDB bucket. See Database and retention policy mapping.
precision
The precision of Unix timestamps in the line protocol.
Default is nanosconds (ns
).
The following precisions are available:
ns
- nanosecondsu
orµ
- microsecondsms
- millisecondss
- secondsm
- minutesh
- hours
Write examples
- Write data using basic authentication
- Write data to a non-default retention policy
- Write multiple lines of line protocol
- Write data with millisecond Unix timestamps
- Use curl to write data from a file
Write data using basic authentication
{{% oss-only %}}
{{% code-placeholders "DATABASE_NAME|USERNAME|PASSWORD_OR_TOKEN|API_TOKEN|exampleuser@influxdata.com" %}}
curl --request POST http://localhost:8086/write?db=DATABASE_NAME \
--user "USERNAME:PASSWORD_OR_TOKEN" \
--data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
{{% /code-placeholders %}}
{{% /oss-only %}}
{{% cloud-only %}} {{% code-placeholders "DATABASE_NAME|USERNAME|PASSWORD_OR_TOKEN|API_TOKEN|exampleuser@influxdata.com" %}}
curl --request POST https://cloud2.influxdata.com/write?db=DATABASE_NAME \
--user "exampleuser@influxdata.com:API_TOKEN" \
--data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
{{% /code-placeholders %}}
{{% /cloud-only %}}
Write data using token authentication
{{% code-placeholders "DATABASE_NAME|USERNAME|PASSWORD_OR_TOKEN|API_TOKEN|exampleuser@influxdata.com" %}}
curl --request POST http://localhost:8086/write?db=DATABASE_NAME \
--header "Authorization: Token API_TOKEN" \
--data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
{{% /code-placeholders %}}
Write data to a non-default retention policy
{{% code-placeholders "DATABASE_NAME|USERNAME|PASSWORD_OR_TOKEN|API_TOKEN|exampleuser@influxdata.com" %}}
curl --request POST "http://localhost:8086/write?db=DATABASE_NAME&rp=RETENTION_POLICY" \
--header "Authorization: Token API_TOKEN" \
--data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
{{% /code-placeholders %}}
Write multiple lines of line protocol
{{% code-placeholders "DATABASE_NAME|USERNAME|PASSWORD_OR_TOKEN|API_TOKEN|exampleuser@influxdata.com" %}}
curl --request POST http://localhost:8086/write?db=DATABASE_NAME \
--header "Authorization: Token API_TOKEN" \
--data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000
measurement,host=host2 field1=14i,field2=12.7 1577836800000000000
measurement,host=host3 field1=5i,field2=6.8 1577836800000000000"
{{% /code-placeholders %}}
Write data with millisecond Unix timestamps
{{% code-placeholders "DATABASE_NAME|USERNAME|PASSWORD_OR_TOKEN|API_TOKEN|exampleuser@influxdata.com" %}}
curl --request POST "http://localhost:8086/write?db=DATABASE_NAME&precision=ms" \
--header "Authorization: Token API_TOKEN" \
--data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000"
{{% /code-placeholders %}}
Use curl to write data from a file
{{% code-placeholders "DATABASE_NAME|USERNAME|PASSWORD_OR_TOKEN|API_TOKEN|exampleuser@influxdata.com" %}}
curl --request POST http://localhost:8086/write?db=DATABASE_NAME \
--header "Authorization: Token API_TOKEN" \
--data-binary @path/to/line-protocol.txt
{{% /code-placeholders %}}
{{% oss-only %}}
Replace the following:
- {{% code-placeholder-key %}}
DATABASE_NAME
andRETENTION_POLICY
{{% /code-placeholder-key %}}: the database and retention policy mapping (DBRP) for the InfluxDB v2 bucket that you want to write to - {{% code-placeholder-key %}}
USERNAME
{{% /code-placeholder-key %}}: your InfluxDB 1.x username - {{% code-placeholder-key %}}
PASSWORD_OR_TOKEN
{{% /code-placeholder-key %}}: your InfluxDB 1.x password or InfluxDB API token - {{% code-placeholder-key %}}
API_TOKEN
{{% /code-placeholder-key %}}: your InfluxDB API token
{{% /oss-only %}}
{{% cloud-only %}}
Replace the following:
- {{% code-placeholder-key %}}
DATABASE_NAME
andRETENTION_POLICY
{{% /code-placeholder-key %}}: the database and retention policy mapping (DBRP) for the InfluxDB v2 bucket that you want to write to - {{% code-placeholder-key %}}}
exampleuser@influxdata.com
{{% /code-placeholder-key %}}: the email address that you signed up with - {{% code-placeholder-key %}}
API_TOKEN
{{% /code-placeholder-key %}}: your InfluxDB API token
{{% /cloud-only %}}