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

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-d—descriptionNew description for the organizationstringINFLUX_ORG_DESCRIPTION
-h—helpHelp for the update command
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
—hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
—http-debugInspect communication with InfluxDB servers.string
-i—id(Required) Organization IDstringINFLUX_ORG_ID
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-n—nameNew organization namestringINFLUX_ORG
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t—tokenAPI tokenstringINFLUX_TOKEN

Examples

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 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"