Replicate data from InfluxDB OSS

Use InfluxDB replication streams (InfluxDB Edge Data Replication) to replicate the incoming data of select buckets to one or more buckets on a remote InfluxDB OSS, InfluxDB Cloud, or InfluxDB Enterprise instance.

Replicate data from InfluxDB OSS to InfluxDB Cloud, InfluxDB OSS, or InfluxDB Enterprise.

Configure a replication stream
Replicate downsampled or processed data

Configure a replication stream

Use the influx CLI or the InfluxDB Cloud API to configure a replication stream.

To replicate data to InfluxDB OSS or InfluxDB Enterprise, adjust the remote connection values accordingly.

CLI API

In your InfluxDB OSS instance, use the influx remote create command to create a remote connection to replicate data to.
Provide the following:
- Remote connection name

InfluxDB Cloud region URL

<ul>

Copy
Fill window

InfluxDB Cloud API token (API token must have write access to the target bucket)

<ul>

Copy
Fill window

InfluxDB Cloud organization ID

```sh
influx remote create \
  --name example-remote-name \
  --remote-url https://cloud2.influxdata.com \
  --remote-api-token mYsuP3r5Ecr37t0k3n \
  --remote-org-id 00xoXXoxXX00
```

If you already have remote InfluxDB connections configured, you can use an existing connection. To view existing connections, run `influx remote list`.

Copy
Fill window

In your InfluxDB OSS instance, use the influx replication create command to create a replication stream.
Provide the following:
- Replication stream name

Remote connection ID

<ul>

Copy
Fill window

InfluxDB OSS bucket ID to replicate writes from

<ul>

Copy
Fill window

InfluxDB Cloud bucket ID to replicate writes to

```sh
influx replication create \
  --name REPLICATION_STREAM_NAME \
  --remote-id REPLICATION_REMOTE_ID \
  --local-bucket-id INFLUX_BUCKET_ID \
  --remote-bucket REMOTE_INFLUX_BUCKET_NAME
```

Copy
Fill window

Once a replication stream is created, InfluxDB will replicate all writes to the specified bucket to the InfluxDB Cloudbucket. Use the influx replication list command to view information such as the current queue size, max queue size, and latest status code.

Send a POST request to your InfluxDB OSS /api/v2/remotes endpoint to create a remote connection to replicate data to.
```
POST undefined/api/v2/remotes
```
- Copy
- Fill window
Include the following in your request:
- Request method: POST
- Headers:
  - Authorization: Token scheme with your InfluxDB OSS API token
  - Content-type: application/json
- Request body: JSON object with the following fields:
  * Required
  - * allowInsecureTLS: All insecure TLS connections
  - description: Remote description
  - * name: Remote connection name
  - * orgID: InfluxDB OSS organization ID

* remoteAPIToken: InfluxDB Cloud API token (API token must have write access to the target bucket)

  <ul>

Copy
Fill window

* remoteOrgID: InfluxDB Cloud organization ID

  <ul>

Copy
Fill window

* remoteURL: InfluxDB Cloud region URL

<div class="keep-url"></div>

```sh
curl --request POST http://localhost:8086/api/v2/remotes \
  --header 'Authorization: Token INFLUX_OSS_TOKEN' \
  --data '{
    "allowInsecureTLS": false,
    "description": "Example remote description",
    "name": "Example remote name",
    "orgID": "INFLUX_OSS_ORG_ID",
    "remoteAPIToken": "REMOTE_INFLUX_TOKEN",
    "remoteOrgID": "REMOTE_INFLUX_ORG_ID",
    "remoteURL": "https://cloud2.influxdata.com"
  }'
```

If you already have remote InfluxDB connections configured, you can use an
existing connection. To view existing connections, use the `/api/v2/remotes`
endpoint with the `GET` request method.

<div class="keep-url"></div>

<pre class="api-endpoint"><a href="/influxdb/cloud/api/#operation/GetRemoteConnections" target="_blank"><span class="api get">GET</span> undefined/api/v2/remotes</a></pre>

Include the following in your request:

- **Request method:** `GET`
- **Headers:**
  - **Authorization:** `Token` scheme with your  InfluxDB OSS [API token](/influxdb/cloud/admin/tokens/)
- **Query parameters:**
  - **orgID:**  InfluxDB OSS organization ID

<div class="keep-url"></div>

```sh
curl --request GET \
  http://localhost:8086/api/v2/remotes?orgID=INFLUX_OSS_ORG_ID \
  --header 'Authorization: Token INFLUX_OSS_TOKEN' \
```

InfluxDB Cloud Region

Copy
Fill window

Send a POST request to your InfluxDB OSS /api/v2/replications endpoint to create a replication stream.
```
POST undefined/api/v2/remotes
```
- Copy
- Fill window
Include the following in your request:
- Request method: POST
- Headers:
  - Authorization: Token scheme with your InfluxDB OSS API token
  - Content-type: application/json
- Request body: JSON object with the following fields: * Required
  - dropNonRetryableData: Drop data when a non-retryable error is encountered.
  - * localBucketID: InfluxDB OSS bucket ID to replicate writes from.
  - * maxAgeSeconds: Maximum age of data in seconds before it is dropped (default is 604800, must be greater than or equal to 0).
  - * maxQueueSizeBytes: Maximum replication queue size in bytes (default is 67108860, must be greater than or equal to 33554430).
  - * name: Replication stream name.
  - * orgID: InfluxDB OSS organization ID.

* remoteBucketID: InfluxDB Cloud bucket ID to replicate writes to.

  <ul>

Copy
Fill window

* remoteBucketName: InfluxDB Cloud bucket name to replicate writes to.

  - <span class="req asterisk ">*</span> **remoteID:** Remote connection ID

Copy
Fill window

remoteBucketID and remoteBucketName are mutually exclusive.

curl --request POST http://localhost:8086/api/v2/replications \
  --header 'Authorization: Token INFLUX_OSS_TOKEN' \
  --data '{
    "dropNonRetryableData": false,
    "localBucketID": "INFLUX_OSS_BUCKET_ID",
    "maxAgeSeconds": 604800,
    "maxQueueSizeBytes": 67108860,
    "name": "Example replication stream name",
    "orgID": "INFLUX_OSS_ORG_ID",
    "remoteBucketName": "REMOTE_INFLUX_BUCKET_NAME",
    "remoteID": "REMOTE_ID",
  }'

  
   Copy
 Fill window

Once a replication stream is created, InfluxDB will replicate all writes from the specified local bucket to the InfluxDB Cloudbucket. To get information such as the current queue size, max queue size, and latest status code for each replication stream, send a GET request to your InfluxDB OSS /api/v2/replications endpoint.

GET undefined/api/v2/replications

Copy
Fill window

Include the following in your request:

Request method: GET
Headers:
- Authorization: Token scheme with your InfluxDB OSS API token
Query parameters:
- orgID: InfluxDB OSS organization ID

curl --request GET \
  http://localhost:8086/api/v2/replications?orgID=INFLUX_OSS_ORG_ID \
  --header 'Authorization: Token INFLUX_OSS_TOKEN' \

  
   Copy
 Fill window

Important things to note

Only write operations are replicated. Other data operations (like deletes or restores) are not replicated.
In InfluxDB OSS, large write request bodies are written entirely. When replicated, write requests are sent to the remote bucket in batches. The maximum batch size is 500 kB (typically between 250 to 500 lines of line protocol). This may result in scenarios where some batches succeed and others fail.

Replicate downsampled or processed data

In some cases, you may not want to write raw, high-precision data to a remote InfluxDB Cloud instance. To replicate only downsampled or processed data:

Create a bucket in your InfluxDB OSS instance to store downsampled or processed data in.

Create an InfluxDB task that downsamples or processes data and stores it in the new bucket. For example:

import "influxdata/influxdb/tasks"
import "types"

// omit this line if adding task via the UI
option task = {name: "Downsample raw data", every: 10m}

data = () => from(bucket: "example-bucket")
    |> range(start: tasks.lastSuccess(orTime: -task.every))

numeric = data()
    |> filter(fn: (r) => types.isType(v: r._value, type: "float") or types.isType(v: r._value, type: "int") or types.isType(v: r._value, type: "uint"))
    |> aggregateWindow(every: task.every, fn: mean)

nonNumeric = data()
    |> filter(fn: (r) => types.isType(v: r._value, type: "string") or types.isType(v: r._value, type: "bool"))
    |> aggregateWindow(every: task.every, fn: last)

union(tables: [numeric, nonNumeric])
    |> to(bucket: "example-downsampled-bucket")

  
   Copy
 Fill window

Create a replication stream to replicate data from the downsampled bucket to the remote InfluxDB Cloud instance.

View InfluxDB OSS replication service metrics

In addition to replication stream information that you can access using the CLI or API, you can view replication service-level metrics for your InfluxDB OSS instance, such as /api/v2/write error details, the number and duration of calls to the service, and the total number of points queued.

To view replication service-level metrics send a GET request to your local InfluxDB OSS /metrics endpoint.

For more information, see InfluxDB OSS metrics.

write replication

Was this page helpful?

Thank you for your feedback!

Support and feedback

Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:

Customers with an annual or support contract can contact InfluxData Support.

Edit this page Submit docs issue Submit InfluxDB issue

Replicate data from InfluxDB OSS

Configure a replication stream

Important things to note

Replicate downsampled or processed data

View InfluxDB OSS replication service metrics

Support and feedback

The future of Flux

InfluxDB 3 Core and Enterprise

Replicate data from InfluxDB OSS

Configure a replication stream

Important things to note

Replicate downsampled or processed data

View InfluxDB OSS replication service metrics

Related

Support and feedback

Select your InfluxDB Cloud region

AWS

GCP

Azure

Thank you for your feedback!

The future of Flux

InfluxDB 3 Core and Enterprise

InfluxDB Cloud powered by TSM