RemoteConnections

Download InfluxDB API Spec
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 required string
The organization ID.
name string
remoteURL string <uri>
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/api/v2/remotes?orgID=ORGID" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 List of remote connections
remotes 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/remotes

Register a new remote connection

Request body required

Content-Type: application/json
allowInsecureTLS required boolean
description string
name required string
orgID required string
remoteAPIToken required string
remoteOrgID string
remoteURL required string <uri>
Example request Ask AI about this
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

201 Remote connection saved
allowInsecureTLS required boolean
description string
id required string
name required string
orgID required string
remoteOrgID string
remoteURL required string <uri>
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/remotes/{remoteID}

Retrieve a remote connection

Parameters

Path parameters
remoteID 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/remotes/{remoteID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Remote connection
allowInsecureTLS required boolean
description string
id required string
name required string
orgID required string
remoteOrgID string
remoteURL required string <uri>
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/remotes/{remoteID}

Update a remote connection

Parameters

Path parameters
remoteID required string
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Content-Type: application/json
allowInsecureTLS boolean
description string
name string
remoteAPIToken string
remoteOrgID string
remoteURL string <uri>
Example request Ask AI about this
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

200 Updated information saved
allowInsecureTLS required boolean
description string
id required string
name required string
orgID required string
remoteOrgID string
remoteURL required string <uri>
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/remotes/{remoteID}

Delete a remote connection

Parameters

Path parameters
remoteID 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/remotes/{remoteID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Remote connection info 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.

Was this page helpful?

Thank you for your feedback!