Replications

Download InfluxDB API Spec
Create and manage replication streams that copy data from an InfluxDB OSS v2 bucket to a remote InfluxDB instance.
GET /api/v2/replications

List all replications

Parameters

Query parameters
orgID required string
The organization ID.
name string
remoteID string
localBucketID string
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/api/v2/replications?orgID=ORGID" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 List of replications
replications object[]
404 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
POST /api/v2/replications

Register a new replication

Parameters

Query parameters
validate boolean
If true, validate the replication, but don’t save it.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Content-Type: application/json
description string
dropNonRetryableData boolean
localBucketID required string
maxAgeSeconds required integer <int64>
Default: 604800
maxQueueSizeBytes required integer <int64>
Default: 67108860
name required string
orgID required string
remoteBucketID string
remoteBucketName string
remoteID required string
Example request Ask AI about this
curl --request POST \
  "http://localhost:8086/api/v2/replications" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "description": "DESCRIPTION",
  "dropNonRetryableData": false,
  "localBucketID": "LOCALBUCKETID",
  "maxAgeSeconds": 604800,
  "maxQueueSizeBytes": 67108860,
  "name": "NAME",
  "orgID": "ORGID",
  "remoteBucketID": "REMOTEBUCKETID",
  "remoteBucketName": "REMOTEBUCKETNAME",
  "remoteID": "REMOTEID"
}'

Responses

201 Replication saved
currentQueueSizeBytes integer <int64>
description string
dropNonRetryableData boolean
id required string
latestErrorMessage string
latestResponseCode integer
localBucketID required string
maxQueueSizeBytes required integer <int64>
name required string
orgID required string
remainingBytesToBeSynced integer <int64>
remoteBucketID string
remoteBucketName string
remoteID required string
204 Replication validated, but not saved
400 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2/replications/{replicationID}

Retrieve a replication

Parameters

Path parameters
replicationID required string
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/api/v2/replications/{replicationID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Replication
currentQueueSizeBytes integer <int64>
description string
dropNonRetryableData boolean
id required string
latestErrorMessage string
latestResponseCode integer
localBucketID required string
maxQueueSizeBytes required integer <int64>
name required string
orgID required string
remainingBytesToBeSynced integer <int64>
remoteBucketID string
remoteBucketName string
remoteID required string
404 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
PATCH /api/v2/replications/{replicationID}

Update a replication

Parameters

Path parameters
replicationID required string
Query parameters
validate boolean
If true, validate the updated information, but don’t save it.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Content-Type: application/json
description string
dropNonRetryableData boolean
maxAgeSeconds integer <int64>
maxQueueSizeBytes integer <int64>
name string
remoteBucketID string
remoteBucketName string
remoteID string
Example request Ask AI about this
curl --request PATCH \
  "http://localhost:8086/api/v2/replications/{replicationID}" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "description": "DESCRIPTION",
  "dropNonRetryableData": false,
  "maxAgeSeconds": 0,
  "maxQueueSizeBytes": 0,
  "name": "NAME",
  "remoteBucketID": "REMOTEBUCKETID",
  "remoteBucketName": "REMOTEBUCKETNAME",
  "remoteID": "REMOTEID"
}'

Responses

200 Updated information saved
currentQueueSizeBytes integer <int64>
description string
dropNonRetryableData boolean
id required string
latestErrorMessage string
latestResponseCode integer
localBucketID required string
maxQueueSizeBytes required integer <int64>
name required string
orgID required string
remainingBytesToBeSynced integer <int64>
remoteBucketID string
remoteBucketName string
remoteID required string
204 Updated replication validated, but not saved
400 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
404 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
DELETE /api/v2/replications/{replicationID}

Delete a replication

Parameters

Path parameters
replicationID required string
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request DELETE \
  "http://localhost:8086/api/v2/replications/{replicationID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Replication deleted.
404 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
POST /api/v2/replications/{replicationID}/validate

Validate a replication

Parameters

Path parameters
replicationID required string
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request POST \
  "http://localhost:8086/api/v2/replications/{replicationID}/validate" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Replication is valid
400 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.

Was this page helpful?

Thank you for your feedback!