influx secret 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 secret update
command adds and updates secrets. Provide the secret key with the -k
or --key
flag. You may also provide the secret value with the -v
or --value
flag. If you do not provide the secret value with the -v
or --value
flag, enter the value when prompted.
Providing a secret value with the -v
or --value
flag may expose the secret in your command history.
Usage
influx secret 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 | |
-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 | ||
—json | Output data as JSON (default false ) | INFLUX_OUTPUT_JSON | ||
-k | —key | (Required) Secret key | string | |
-o | —org | Organization name (mutually exclusive with —org-id ) | string | INFLUX_ORG |
—org-id | Organization ID (mutually exclusive with —org ) | string | INFLUX_ORG_ID | |
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | —token | API token | string | INFLUX_TOKEN |
-v | —value | (Required) Secret value | string |
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
Add a secret
influx secret update \
--key EXAMPLE_KEY \
--value EXAMPLE_VALUE
Update an existing secret
influx secret update \
--key EXAMPLE_KEY \
--value NEW_EXAMPLE_VALUE
Related
- Manage secrets
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions