influx org update

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+

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

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