--- title: RemoteConnections description: Create and manage remote InfluxDB connections for replicating data from an InfluxDB OSS v2 instance to a remote InfluxDB instance. url: https://docs.influxdata.com/influxdb/v2/api/remoteconnections/ estimated_tokens: 2578 product: InfluxDB OSS v2 version: v2 publisher: InfluxData canonical: https://docs.influxdata.com/influxdb/v2/api/remoteconnections/ --- [Download InfluxDB API Spec](/openapi/influxdb-oss-v2-api.yml) Create and manage remote InfluxDB connections for replicating data from an InfluxDB OSS v2 instance to a remote InfluxDB instance. GET`/api/v2/remotes` ### List all remote connections #### Parameters ##### Query parameters `orgID`requiredstring The organization ID. `name`string `remoteURL`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/remotes?orgID=ORGID" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200List of remote connections `remotes`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/remotes` ### Register a new remote connection #### Request bodyrequired Content-Type:`application/json` `allowInsecureTLS`requiredboolean `description`string `name`requiredstring `orgID`requiredstring `remoteAPIToken`requiredstring `remoteOrgID`string `remoteURL`requiredstring \ Example request[Ask AI about this](#) ```sh curl --request POST \ "http://localhost:8086/api/v2/remotes" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" \ --data-raw '{ "allowInsecureTLS": false, "description": "DESCRIPTION", "name": "NAME", "orgID": "ORGID", "remoteAPIToken": "REMOTEAPITOKEN", "remoteOrgID": "REMOTEORGID", "remoteURL": "REMOTEURL" }' ``` #### Responses 201Remote connection saved `allowInsecureTLS`requiredboolean `description`string `id`requiredstring `name`requiredstring `orgID`requiredstring `remoteOrgID`string `remoteURL`requiredstring \ 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/remotes/{remoteID}` ### Retrieve a remote connection #### Parameters ##### Path parameters `remoteID`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/remotes/{remoteID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200Remote connection `allowInsecureTLS`requiredboolean `description`string `id`requiredstring `name`requiredstring `orgID`requiredstring `remoteOrgID`string `remoteURL`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/remotes/{remoteID}` ### Update a remote connection #### Parameters ##### Path parameters `remoteID`requiredstring ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Content-Type:`application/json` `allowInsecureTLS`boolean `description`string `name`string `remoteAPIToken`string `remoteOrgID`string `remoteURL`string \ Example request[Ask AI about this](#) ```sh curl --request PATCH \ "http://localhost:8086/api/v2/remotes/{remoteID}" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" \ --data-raw '{ "allowInsecureTLS": false, "description": "DESCRIPTION", "name": "NAME", "remoteAPIToken": "REMOTEAPITOKEN", "remoteOrgID": "REMOTEORGID", "remoteURL": "REMOTEURL" }' ``` #### Responses 200Updated information saved `allowInsecureTLS`requiredboolean `description`string `id`requiredstring `name`requiredstring `orgID`requiredstring `remoteOrgID`string `remoteURL`requiredstring \ 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/remotes/{remoteID}` ### Delete a remote connection #### Parameters ##### Path parameters `remoteID`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/remotes/{remoteID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Remote connection info 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.