telegraf secrets list
The telegraf secrets list command lists known secrets and secret stores.
This command requires your configuration file that contains the secret store
definitions you want to access. If the --config or --config-directory flags
are not included in the command, Telegraf checks the
default configuration file location.
If you haven’t configured a secret store, use
telegraf plugins secretstores
to list available secret store plugins.
View secret store plugin configuration documentation in the
Telegraf GitHub repository.
Usage
telegraf [global-flags] secrets list [flags] [SECRET_STORE_ID[ ...[SECRET_STORE_ID]]]
Arguments
| Argument | Description |
|---|---|
| SECRET_STORE_ID | ID of the secret store to list secrets from. You can include multiple, space-delimited IDs. If no ID(s) are provided, the command lists secrets from all secret stores. |
Flags
| Flag | Description | |
|---|---|---|
--reveal-secret | Print secret values | |
-h | --help | Show command help |
Also see Telegraf global flags.
Examples
- List secrets and secret stores using the default configuration location
- List secrets and secret stores using a non-default configuration location
- List secrets from a specific secret store
- Show secret values when listing secrets and secret stores
List secrets and secret stores using the default configuration location
The following example assumes the Telegraf configuration file that contains the secret store definition is at the default location.
telegraf secrets list
List secrets and secret stores using a non-default configuration location
telegraf --config CUSTOM_CONFIG_PATH secrets list
- Replace
CUSTOM_CONFIG_PATHwith the non-default filepath to your Telegraf configuration file containing your secret store definitions.
List secrets from a specific secret store
telegraf secrets list SECRET_STORE_ID
- Replace
SECRET_STORE_IDwith the ID of the secret store to retrieve the secret from.
Show secret values when listing secrets and secret stores
To print secret values with listing secrets and secret stores, include the
--reveal-secret flag:
telegraf secrets list --reveal-secret
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Telegraf and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.