telegraf secrets list

The telegraf secrets list command lists known secrets and secret stores.

{{% note %}} 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. {{% /note %}}

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

Flags

{{% caption %}} Also see Telegraf global flags. {{% /caption %}}

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

{{% code-placeholders "CUSTOM_CONFIG_PATH" %}}

telegraf --config CUSTOM_CONFIG_PATH secrets list

{{% /code-placeholders %}}

• Replace {{% code-placeholder-key %}}CUSTOM_CONFIG_PATH{{% /code-placeholder-key %}} with the non-default filepath to your Telegraf configuration file containing your secret store definitions.

List secrets from a specific secret store

{{% code-placeholders "SECRET_STORE_ID" %}}

telegraf secrets list SECRET_STORE_ID

{{% /code-placeholders %}}

• Replace {{% code-placeholder-key %}}SECRET_STORE_ID{{% /code-placeholder-key %}} with 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