Documentation

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.

Usage

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

Flags

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

Example

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

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 remote \
      --id 0ooxX0xxXo0x
      --name new-example-name
      --description new-examle-description
      --remote-url http://new-example-url.com
      --remote-api-token myN3wS3crE7t0k3n==
      --remote-org-id new-example-org-id
    

Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.