influx remote update

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

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

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

Flags

FlagDescriptionInput typeMaps to ?
-i—idRemote connection ID to updatestring
-n—nameNew name for the remote connectionstring
-d—descriptionNew remote connection descriptionstring
—remote-urlNew remote InfluxDB URLstring
—remote-api-tokenNew remote InfluxDB API tokenstring
—remote-org-idNew remote organization IDstring
—allow-insecure-tlsAllows insecure TLS connections
—hostInfluxDB HTTP address (default http://localhost:8086)stringINFLUX_HOST
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-c—active-configCLI configuration to use for commandstring
—http-debugInspect communication with InfluxDB serversstring
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
-t—tokenInfluxDB API tokenstringINFLUX_TOKEN

Example

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.

    1. $ influx remote list
    2. ID                    Name        Org ID
    3. 0ooxX0xxXo0x         myremote    [...]

  2. Use the following command to update the remote:

    1. influx remote update \
    2.   --id 0ooxX0xxXo0x
    3.   --name new-example-name
    4.   --description new-example-description
    5.   --remote-url http://new-example-url.com
    6.   --remote-api-token myN3wS3crE7t0k3n==
    7.   --remote-org-id new-example-org-id

write replication