Documentation

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]]]
  • Copy
  • Fill window

Arguments

ArgumentDescription
SECRET_STORE_IDID 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

FlagDescription
--reveal-secretPrint secret values
-h--helpShow command help

Examples

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
  • Copy
  • Fill window

List secrets and secret stores using a non-default configuration location

telegraf --config 
CUSTOM_CONFIG_PATH
secrets list
  • Copy
  • Fill window
  • Replace CUSTOM_CONFIG_PATH with 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
  • Copy
  • Fill window
  • Replace SECRET_STORE_ID 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
  • Copy
  • Fill window

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: