Documentation

influx org update

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

Usage

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

Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.