influx org update

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+

The influx org update command updates information related to organizations in InfluxDB.

Usage

1. influx org update [flags]

Flags

Flag Description Input type Maps to ?
-c —active-config CLI configuration to use for command string
—configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
-d —description New description for the organization string INFLUX_ORG_DESCRIPTION
-h —help Help for the update command
—hide-headers Hide table headers (default false) INFLUX_HIDE_HEADERS
—host HTTP address of InfluxDB (default http://localhost:8086) string INFLUX_HOST
—http-debug Inspect communication with InfluxDB servers. string
-i —id (Required) Organization ID string INFLUX_ORG_ID
—json Output data as JSON (default false) INFLUX_OUTPUT_JSON
-n —name New organization name string INFLUX_ORG
—skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
-t —token API token string INFLUX_TOKEN

Examples

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 the name of an organization
1. influx org update \
2. --id 0Xx0oox00XXoxxoo1
3. --name new-org-name
Update the description of an organization
1. influx org update \
2. --id 0Xx0oox00XXoxxoo1
3. --description "New example organization description"