docs-v2/content/influxdb/cloud/reference/api/influxdb-1x/write.md

4.7 KiB

title list_title description menu weight influxdb/cloud/tags products list_code_example related
/write 1.x compatibility API /write The `/write` 1.x compatibilty endpoint writes data to InfluxDB Cloud using patterns from the InfluxDB 1.x `/write` API endpoint.
influxdb_cloud_ref
name parent
/write 1.x compatibility
301
write
cloud
<pre> <span class="api post">POST</span> https://cloud2.influxdata.com/write </pre>
/influxdb/cloud/reference/syntax/line-protocol

The /write 1.x compatibility endpoint writes data to InfluxDB Cloud and InfluxDB OSS 2.0 using patterns from the InfluxDB 1.x /write API endpoint. Use the POST request method to write line protocol to the /write endpoint.

{{< api-endpoint method="post" endpoint="https://cloud2.influxdata.com/write" >}}

{{% 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 %}}

Authentication

{{% api/v1-compat/cloud/authentication %}}

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

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.

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 - nanoseconds
  • u or µ - microseconds
  • ms - milliseconds
  • s - seconds
  • m - minutes
  • h - hours

Write examples

Write data using basic authentication
curl --request POST https://cloud2.influxdata.com/write?db=mydb \
  --user "myusername:YourAuthToken" \
  --data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
Write data using token authentication
curl --request POST https://cloud2.influxdata.com/write?db=mydb \
  --header "Authorization: Token YourAuthToken" \
  --data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
Write data to a non-default retention policy
curl --request POST https://cloud2.influxdata.com/write?db=mydb&rp=customrp \
  --user "myusername:YourAuthToken" \
  --data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
Write multiple lines of line protocol
curl --request POST https://cloud2.influxdata.com/write?db=mydb \
  --header "Authorization: Token YourAuthToken" \
  --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"
Write data with millisecond Unix timestamps
curl --request POST https://cloud2.influxdata.com/write?db=mydb&precision=ms \
  --header "Authorization: Token YourAuthToken" \
  --data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000"
Use curl to write data from a file
curl --request POST https://cloud2.influxdata.com/write?db=mydb \
  --header "Authorization: Token YourAuthToken" \
  --data-binary @path/to/line-protocol.txt