--- title: Replications description: Create and manage replication streams that copy data from an InfluxDB OSS v2 bucket to a remote InfluxDB instance. url: https://docs.influxdata.com/influxdb/v2/api/replications/ estimated_tokens: 3373 product: InfluxDB OSS v2 version: v2 publisher: InfluxData canonical: https://docs.influxdata.com/influxdb/v2/api/replications/ --- [Download InfluxDB API Spec](/openapi/influxdb-oss-v2-api.yml) 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`requiredstring The organization ID. `name`string `remoteID`string `localBucketID`string ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/replications?orgID=ORGID" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200List of replications `replications`object[] 404Non 2XX error response from server. `code`requiredstring 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. defaultNon 2XX error response from server. `code`requiredstring 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 bodyrequired Content-Type:`application/json` `description`string `dropNonRetryableData`boolean `localBucketID`requiredstring `maxAgeSeconds`requiredinteger \ Default:`604800` `maxQueueSizeBytes`requiredinteger \ Default:`67108860` `name`requiredstring `orgID`requiredstring `remoteBucketID`string `remoteBucketName`string `remoteID`requiredstring Example request[Ask AI about this](#) ```sh 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 201Replication saved `currentQueueSizeBytes`integer \ `description`string `dropNonRetryableData`boolean `id`requiredstring `latestErrorMessage`string `latestResponseCode`integer `localBucketID`requiredstring `maxQueueSizeBytes`requiredinteger \ `name`requiredstring `orgID`requiredstring `remainingBytesToBeSynced`integer \ `remoteBucketID`string `remoteBucketName`string `remoteID`requiredstring 204Replication validated, but not saved 400Non 2XX error response from server. `code`requiredstring 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. defaultNon 2XX error response from server. `code`requiredstring 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`requiredstring ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/replications/{replicationID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200Replication `currentQueueSizeBytes`integer \ `description`string `dropNonRetryableData`boolean `id`requiredstring `latestErrorMessage`string `latestResponseCode`integer `localBucketID`requiredstring `maxQueueSizeBytes`requiredinteger \ `name`requiredstring `orgID`requiredstring `remainingBytesToBeSynced`integer \ `remoteBucketID`string `remoteBucketName`string `remoteID`requiredstring 404Non 2XX error response from server. `code`requiredstring 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. defaultNon 2XX error response from server. `code`requiredstring 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`requiredstring ##### 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 bodyrequired Content-Type:`application/json` `description`string `dropNonRetryableData`boolean `maxAgeSeconds`integer \ `maxQueueSizeBytes`integer \ `name`string `remoteBucketID`string `remoteBucketName`string `remoteID`string Example request[Ask AI about this](#) ```sh 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 200Updated information saved `currentQueueSizeBytes`integer \ `description`string `dropNonRetryableData`boolean `id`requiredstring `latestErrorMessage`string `latestResponseCode`integer `localBucketID`requiredstring `maxQueueSizeBytes`requiredinteger \ `name`requiredstring `orgID`requiredstring `remainingBytesToBeSynced`integer \ `remoteBucketID`string `remoteBucketName`string `remoteID`requiredstring 204Updated replication validated, but not saved 400Non 2XX error response from server. `code`requiredstring 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. 404Non 2XX error response from server. `code`requiredstring 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. defaultNon 2XX error response from server. `code`requiredstring 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`requiredstring ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request DELETE \ "http://localhost:8086/api/v2/replications/{replicationID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Replication deleted. 404Non 2XX error response from server. `code`requiredstring 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. defaultNon 2XX error response from server. `code`requiredstring 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`requiredstring ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request POST \ "http://localhost:8086/api/v2/replications/{replicationID}/validate" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Replication is valid 400Non 2XX error response from server. `code`requiredstring 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. defaultNon 2XX error response from server. `code`requiredstring 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.