influx remote update

Replication remotes and replication streams can only be configured for InfluxDB OSS.

The influx remote update command updates an existing InfluxDB remote connection used for replicating data.


influx remote update [command options] [arguments...]


Flag Description Input type Maps to ?
-i --id Remote connection ID to update string
-n --name New name for the remote connection string
-d --description New remote connection description string
--remote-url New remote InfluxDB URL string
--remote-api-token New remote InfluxDB API token string
--remote-org-id New remote organization ID string
--allow-insecure-tls Allows insecure TLS connections
--host InfluxDB HTTP address (default http://localhost:8086) string INFLUX_HOST
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
--configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
-c --active-config CLI configuration to use for command string
--http-debug Inspect communication with InfluxDB servers string
--json Output data as JSON (default false) INFLUX_OUTPUT_JSON
--hide-headers Hide table headers (default false) INFLUX_HIDE_HEADERS
-t --token InfluxDB API token string INFLUX_TOKEN


Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:

  • --host: InfluxDB host
  • -o, --org or --org-id: InfluxDB organization name or ID
  • -t, --token: InfluxDB API token

Update a remote

  1. Use influx remote list to get the ID for the remote you want to update.
    $ influx remote list
    ID			        Name		Org ID
    0ooxX0xxXo0x 	    myremote    [...]
  2. Use the following command to update the remote:
    influx remote update \
      --id 0ooxX0xxXo0x
      --name new-example-name
      --description new-example-description
      --remote-api-token myN3wS3crE7t0k3n==
      --remote-org-id new-example-org-id

Was this page helpful?

Thank you for your feedback!

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: