Replicate data from InfluxDB OSS

Step 1: Create or find a remote connection

• Create a remote connection
• Use an existing remote connection

Create a remote connection (CLI)

In your local InfluxDB OSS instance, use the influx remote create command and provide the following arguments for the remote instance:

• Remote connection name
• Remote InfluxDB instance URL
• Remote InfluxDB API token (API token must have write access to the target bucket)
• Remote InfluxDB organization ID

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

Use an existing remote connection (CLI)

Alternatively, you can use an existing connection that you have already configured. To retrieve existing connections, run influx remote list.

Step 2: Create a replication stream (CLI)

In your local InfluxDB OSS instance, use the influx replication create command and provide the following arguments:

• Replication stream name
• Remote connection ID (created in the previous step)
• Local bucket ID to replicate writes from
• Remote bucket name or ID to replicate writes to. If replicating to InfluxDB Enterprise v1, use the db-name/rp-name bucket name syntax.

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

After you create the replication stream, InfluxDB OSS replicates all writes to the specified local bucket to the remote InfluxDB bucket. Use the influx replication list command to view information such as the current queue size, max queue size, and latest status code.

Step 1: Create or find a remote connection (API)

• Create a remote connection
• Use an existing remote connection

Create a remote connection (API)

To create a remote connection to replicate data to, send a POST request to your local InfluxDB OSS /api/v2/remotes endpoint:

POST localhost:8086/api/v2/remotes

Include the following parameters in your request:

• Request method: POST
• Headers:
  • Authorization: Token scheme with your local 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: local InfluxDB OSS organization ID
  • * remoteAPIToken: Remote InfluxDB API token (API token must have write access to the target bucket)
  • * remoteOrgID: Remote InfluxDB organization ID
  • * remoteURL: Remote InfluxDB instance URL

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"
  }'

Use an existing remote connection (API)

Alternatively, you can use an existing connection that you have already configured. To retrieve existing connections, use the /api/v2/remotes endpoint with the GET request method:

GET localhost:8086/api/v2/remotes

Include the following parameters in your request:

• Headers:
  • Authorization: Token scheme with your local InfluxDB OSS API token
• Query parameters:
  • orgID: Local InfluxDB OSS organization ID

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

Step 2: Create a replication stream (API)

Send a POST request to your local InfluxDB OSS /api/v2/replications endpoint to create a replication stream.

POST localhost:8086/api/v2/remotes

Include the following parameters in your request:

• Headers:
  • Authorization: Token scheme with your local 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: Local 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: Local InfluxDB OSS organization ID.
  • * remoteBucketID: Remote bucket ID to replicate writes to.
  • * remoteBucketName: Remote bucket name to replicate writes to. If replicating to InfluxDB Enterprise v1, use the db-name/rp-name bucket name syntax.

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",
  }'

After you create a replication stream, InfluxDB OSS replicates all writes from the specified local bucket to the remote InfluxDB bucket. 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 local InfluxDB OSS /api/v2/replications endpoint:

GET localhost:8086/api/v2/replications

Include the following parameters in your request:

• Headers:
  • Authorization: Token scheme with your local InfluxDB OSS API token
• Query parameters:
  • orgID: Local InfluxDB OSS organization ID

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